ksiface.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	KSIOBJECT_BAG

Macros
#define	DEFINE_ABSTRACT_UNKNOWN()
#define	INTERFACE   IKsAllocator
#define	INTERFACE   IKsClock
#define	INTERFACE   IKsTransport
#define	INTERFACE   IKsPin
#define	INTERFACE   IKsQueue
#define	INTERFACE   IKsFilter
#define	INTERFACE   IKsFilterFactory
#define	INTERFACE   IKsPowerNotify
#define	INTERFACE   IKsDevice
#define	INTERFACE   IKsProcessingObject

Typedefs
typedef struct KSIOBJECT_BAG *	PKSIOBJECT_BAG

Functions
	DECLARE_INTERFACE_ (IKsAllocator, IUnknown)
	DECLARE_INTERFACE_ (IKsClock, IUnknown)
	DECLARE_INTERFACE_ (IKsTransport, IUnknown)
	DECLARE_INTERFACE_ (IKsPin, IUnknown)
	DECLARE_INTERFACE_ (IKsQueue, IUnknown)
	DECLARE_INTERFACE_ (IKsFilter, IUnknown)
	DECLARE_INTERFACE_ (IKsFilterFactory, IUnknown)
	DECLARE_INTERFACE_ (IKsPowerNotify, IUnknown)
	DECLARE_INTERFACE_ (IKsDevice, IUnknown)
	DECLARE_INTERFACE_ (IKsProcessingObject, IUnknown)

Macro Definition Documentation

DEFINE_ABSTRACT_UNKNOWN

#define DEFINE_ABSTRACT_UNKNOWN

(

)

Value:

    STDMETHOD_(NTSTATUS, QueryInterface)(THIS_                  \
        REFIID InterfaceId,                                     \
        PVOID* Interface)PURE;                                  \
    STDMETHOD_(ULONG,AddRef)(THIS) PURE;                        \
    STDMETHOD_(ULONG,Release)(THIS) PURE;

Definition at line 5 of file ksiface.h.

INTERFACE [1/10]

#define INTERFACE   IKsAllocator

Definition at line 317 of file ksiface.h.

INTERFACE [2/10]

#define INTERFACE   IKsClock

Definition at line 317 of file ksiface.h.

INTERFACE [3/10]

#define INTERFACE   IKsTransport

Definition at line 317 of file ksiface.h.

INTERFACE [4/10]

#define INTERFACE   IKsPin

Definition at line 317 of file ksiface.h.

INTERFACE [5/10]

#define INTERFACE   IKsQueue

Definition at line 317 of file ksiface.h.

INTERFACE [6/10]

#define INTERFACE   IKsFilter

Definition at line 317 of file ksiface.h.

INTERFACE [7/10]

#define INTERFACE   IKsFilterFactory

Definition at line 317 of file ksiface.h.

INTERFACE [8/10]

#define INTERFACE   IKsPowerNotify

Definition at line 317 of file ksiface.h.

INTERFACE [9/10]

#define INTERFACE   IKsDevice

Definition at line 317 of file ksiface.h.

INTERFACE [10/10]

#define INTERFACE   IKsProcessingObject

Definition at line 317 of file ksiface.h.

Typedef Documentation

PKSIOBJECT_BAG

typedef struct KSIOBJECT_BAG * PKSIOBJECT_BAG

Function Documentation

DECLARE_INTERFACE_() [1/10]

DECLARE_INTERFACE_	(	IKsAllocator	,
		IUnknown
	)

Definition at line 30 of file ksiface.h.

{
    DEFINE_ABSTRACT_UNKNOWN()
 
    STDMETHOD_(NTSTATUS, DispatchDeviceIoControl)(THIS_
        IN PDEVICE_OBJECT DeviceObject,
        IN PIRP Irp) PURE;
 
    STDMETHOD_(NTSTATUS, Close)(THIS) PURE;
 
    STDMETHOD_(NTSTATUS, AllocateFrame)(THIS_
        IN PVOID * OutFrame) PURE;
 
    STDMETHOD_(VOID, FreeFrame)(THIS_
        IN PVOID OutFrame) PURE;
};

DECLARE_INTERFACE_() [2/10]

DECLARE_INTERFACE_	(	IKsClock	,
		IUnknown
	)

Definition at line 56 of file ksiface.h.

{
    DEFINE_ABSTRACT_UNKNOWN()
};

DECLARE_INTERFACE_() [3/10]

DECLARE_INTERFACE_	(	IKsDevice	,
		IUnknown
	)

Definition at line 268 of file ksiface.h.

{
    DEFINE_ABSTRACT_UNKNOWN()
 
    STDMETHOD_(KSDEVICE*,GetStruct)(THIS) PURE;
 
    STDMETHOD_(NTSTATUS, InitializeObjectBag)(THIS_
        IN PKSIOBJECT_BAG Bag,
        IN PRKMUTEX Mutex) PURE;
 
    STDMETHOD_(NTSTATUS,AcquireDevice)(THIS) PURE;
    STDMETHOD_(NTSTATUS,ReleaseDevice)(THIS) PURE;
 
    STDMETHOD_(NTSTATUS, GetAdapterObject)(THIS_
        IN PADAPTER_OBJECT * Object,
        IN PULONG MaxMappingsByteCount,
        IN PULONG MappingTableStride) PURE;
 
    STDMETHOD_(NTSTATUS, AddPowerEntry)(THIS_
        IN struct KSPOWER_ENTRY * Entry,
        IN IKsPowerNotify* Notify)PURE;
 
    STDMETHOD_(NTSTATUS, RemovePowerEntry)(THIS_
        IN struct KSPOWER_ENTRY * Entry)PURE;
 
    STDMETHOD_(NTSTATUS, PinStateChange)(THIS_
        IN KSPIN Pin,
        IN PIRP Irp,
        IN KSSTATE OldState,
        IN KSSTATE NewState)PURE;
 
    STDMETHOD_(NTSTATUS, ArbitrateAdapterChannel)(THIS_
        IN ULONG NumberOfMapRegisters,
        IN PDRIVER_CONTROL ExecutionRoutine,
        IN PVOID Context)PURE;
 
    STDMETHOD_(NTSTATUS, CheckIoCapability)(THIS_
        IN ULONG Unknown)PURE;
};

DECLARE_INTERFACE_() [4/10]

DECLARE_INTERFACE_	(	IKsFilter	,
		IUnknown
	)

Definition at line 164 of file ksiface.h.

{
    DEFINE_ABSTRACT_UNKNOWN()
 
    STDMETHOD_(PKSFILTER, GetStruct)(THIS) PURE;
 
    STDMETHOD_(BOOL, DoAllNecessaryPinsExist)(THIS) PURE;
 
    STDMETHOD_(NTSTATUS, CreateNode)(THIS_
        IN PIRP Irp,
        IN IKsPin * Pin,
        IN PLIST_ENTRY ListEntry) PURE;
 
    STDMETHOD_(NTSTATUS, BindProcessPinsToPipeSection)(THIS_
        IN struct KSPROCESSPIPESECTION *Section,
        IN PVOID Create,
        IN PKSPIN KsPin,
        OUT IKsPin **Pin,
        OUT PKSGATE *OutGate) PURE;
 
    STDMETHOD_(NTSTATUS, UnbindProcessPinsFromPipeSection)(THIS_
        IN struct KSPROCESSPIPESECTION *Section) PURE;
 
    STDMETHOD_(NTSTATUS, AddProcessPin)(THIS_
        IN PKSPROCESSPIN ProcessPin) PURE;
 
    STDMETHOD_(NTSTATUS, RemoveProcessPin)(THIS_
        IN PKSPROCESSPIN ProcessPin) PURE;
 
    STDMETHOD_(BOOL, ReprepareProcessPipeSection)(THIS_
        IN struct KSPROCESSPIPESECTION *PipeSection,
        IN PULONG Data) PURE;
 
    STDMETHOD_(VOID, DeliverResetState)(THIS_
        IN struct KSPROCESSPIPESECTION *PipeSection,
        IN KSRESET ResetState) PURE;
 
    STDMETHOD_(BOOL, IsFrameHolding)(THIS);
 
    STDMETHOD_(VOID, RegisterForCopyCallbacks)(THIS_
        IKsQueue * Queue,
        IN BOOL Enable) PURE;
 
    STDMETHOD_(PKSPROCESSPIN_INDEXENTRY, GetProcessDispatch)(THIS);
};

DECLARE_INTERFACE_() [5/10]

DECLARE_INTERFACE_	(	IKsFilterFactory	,
		IUnknown
	)

Definition at line 218 of file ksiface.h.

{
    DEFINE_ABSTRACT_UNKNOWN()
 
    STDMETHOD_(KSFILTERFACTORY*, GetStruct)(THIS) PURE;
 
    STDMETHOD_(NTSTATUS, SetDeviceClassesState)(THIS_
        IN BOOLEAN Enable)PURE;
 
    STDMETHOD_(NTSTATUS, Initialize)(THIS_
        IN PDEVICE_OBJECT  DeviceObject,
        IN const KSFILTER_DESCRIPTOR  *Descriptor,
        IN PWSTR  RefString OPTIONAL,
        IN PSECURITY_DESCRIPTOR  SecurityDescriptor OPTIONAL,
        IN ULONG  CreateItemFlags,
        IN PFNKSFILTERFACTORYPOWER  SleepCallback OPTIONAL,
        IN PFNKSFILTERFACTORYPOWER  WakeCallback OPTIONAL,
        OUT PKSFILTERFACTORY  *FilterFactory OPTIONAL)PURE;
};

DECLARE_INTERFACE_() [6/10]

DECLARE_INTERFACE_	(	IKsPin	,
		IUnknown
	)

Definition at line 85 of file ksiface.h.

{
    DEFINE_ABSTRACT_UNKNOWN()
 
    STDMETHOD_(NTSTATUS, TransferKsIrp)(THIS_
        IN PIRP Irp,
        IN IKsTransport **OutTransport) PURE;
 
    STDMETHOD_(VOID, DiscardKsIrp)(THIS_
        IN PIRP Irp,
        IN IKsTransport * *OutTransport) PURE;
 
    STDMETHOD_(NTSTATUS, Connect)(THIS_
        IN IKsTransport * TransportIn,
        OUT IKsTransport ** OutTransportIn,
        OUT IKsTransport * *OutTransportOut,
        IN KSPIN_DATAFLOW DataFlow) PURE;
 
    STDMETHOD_(NTSTATUS, SetDeviceState)(THIS_
        IN KSSTATE OldState,
        IN KSSTATE NewState,
        IN IKsTransport * *OutTransport) PURE;
 
    STDMETHOD_(VOID, SetResetState)(THIS_
        IN KSRESET ResetState,
        OUT IKsTransport * * OutTransportOut) PURE;
 
    STDMETHOD_(NTSTATUS, GetTransportConfig)(THIS_
        IN struct KSPTRANSPORTCONFIG * TransportConfig,
        OUT IKsTransport ** OutTransportIn,
        OUT IKsTransport ** OutTransportOut) PURE;
 
    STDMETHOD_(NTSTATUS, SetTransportConfig)(THIS_
        IN struct KSPTRANSPORTCONFIG const * TransportConfig,
        OUT IKsTransport ** OutTransportIn,
        OUT IKsTransport ** OutTransportOut) PURE;
 
    STDMETHOD_(NTSTATUS, ResetTransportConfig)(THIS_
        OUT IKsTransport ** OutTransportIn,
        OUT IKsTransport ** OutTransportOut) PURE;
 
    STDMETHOD_(PKSPIN, GetStruct)(THIS) PURE;
    STDMETHOD_(PKSPROCESSPIN, GetProcessPin)(THIS) PURE;
    STDMETHOD_(NTSTATUS, AttemptBypass)(THIS) PURE;
    STDMETHOD_(NTSTATUS, AttemptUnbypass)(THIS) PURE;
 
    STDMETHOD_(VOID, GenerateConnectionEvents)(THIS_
        IN ULONG EventMask) PURE;
 
    STDMETHOD_(NTSTATUS, ClientSetDeviceState)(THIS_
        IN KSSTATE StateIn,
        IN KSSTATE StateOut) PURE;
};

DECLARE_INTERFACE_() [7/10]

DECLARE_INTERFACE_	(	IKsPowerNotify	,
		IUnknown
	)

Definition at line 247 of file ksiface.h.

{
    DEFINE_ABSTRACT_UNKNOWN()
 
    STDMETHOD_(VOID,Sleep)(THIS_
        IN DEVICE_POWER_STATE State) PURE;
 
    STDMETHOD_(VOID,Wake)(THIS) PURE;
};

DECLARE_INTERFACE_() [8/10]

DECLARE_INTERFACE_	(	IKsProcessingObject	,
		IUnknown
	)

Definition at line 319 of file ksiface.h.

{
    DEFINE_ABSTRACT_UNKNOWN()
 
    STDMETHOD_(VOID, ProcessingObjectWork)(THIS) PURE;
 
    STDMETHOD_(PKSGATE, GetAndGate)(THIS) PURE;
 
    STDMETHOD_(VOID, Process)(THIS_
        IN BOOLEAN Asynchronous)PURE;
 
    STDMETHOD_(VOID, Reset)(THIS) PURE;
 
    STDMETHOD_(VOID, TriggerNotification)(THIS) PURE;
 
};

DECLARE_INTERFACE_() [9/10]

DECLARE_INTERFACE_	(	IKsQueue	,
		IUnknown
	)

Definition at line 147 of file ksiface.h.

{
    DEFINE_ABSTRACT_UNKNOWN()
 
};

DECLARE_INTERFACE_() [10/10]

DECLARE_INTERFACE_	(	IKsTransport	,
		IUnknown
	)

Definition at line 69 of file ksiface.h.

{
    DEFINE_ABSTRACT_UNKNOWN()
};