KsGetPinFromFileObject function

The KsGetPinFromFileObject function returns the AVStream pin object associated with FileObject.

Syntax

PKSPIN KsGetPinFromFileObject(
  PFILE_OBJECT FileObject
);

Parameters

FileObject

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

Return Value

KsGetPinFromFileObject returns a pointer to the KSPIN structure associated with FileObject.

Remarks

The minidriver must verify that FileObject is a file object associated with an AVStream pin. Do this by calling KsGetObjectTypeFromFileObject.

This call is an inline call to KsGetObjectFromFileObject. KsGetPinFromFileObject typecasts the return as a PKSPIN.

Requirements

   
Windows version Available in Microsoft Windows XP and later operating systems and DirectX 8.0 and later DirectX versions.
Target Platform Desktop
Header ks.h (include Ks.h)
IRQL Any level

See Also

KsGetObjectFromFileObject

KsGetObjectTypeFromFileObject