Expand Minimize

KsGetFilterFromFileObject function

The KsGetFilterFromFileObject function returns the AVStream filter object associated with FileObject.

Syntax


PKSFILTER __inline KsGetFilterFromFileObject(
  _In_  PFILE_OBJECT FileObject
);

Parameters

FileObject [in]

A pointer to the FILE_OBJECT for which to return the associated AVStream filter object.

Return value

KsGetFilterFromFileObject returns a pointer to the KSFILTER structure associated with FileObject.

Remarks

It is the responsibility of the minidriver to verify that FileObject is a file object associated with an AVStream filter. Do this by calling KsGetObjectTypeFromFileObject before calling KsGetFilterFromFileObject.

KsGetFilterFromFileObject is an inline call to KsGetObjectFromFileObject. The difference is that KsGetFilterFromFileObject typecasts the return as type pointer to a KSFILTER structure.

Requirements

Version

Available in Microsoft Windows XP and later operating systems and DirectX 8.0 and later DirectX versions.

Header

Ks.h (include Ks.h)

IRQL

Any level

See also

KsGetObjectFromFileObject
KsGetObjectTypeFromFileObject
KsGetDeviceForDeviceObject

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft