KsGetChildCreateParameter function

The KsGetChildCreateParameter function returns the standard parameter passed to a create request. It is used when passing a create parameter in the standard method used for creating pins, clocks, and allocators.

Syntax

KSDDKAPI NTSTATUS NTAPI KsGetChildCreateParameter(
  _In_  PIRP  Irp,
  _Out_ PVOID *CreateParameter
);

Parameters

  • Irp [in]
    Specifies the Create IRP whose parameter is being retrieved.

  • CreateParameter [out]
    Location in which to return the create information.

Return value

The KsGetChildCreateParameter function returns STATUS_SUCCESS if successful or STATUS_INVALID_PARAMETER if the size was incorrect.

Remarks

The KsGetChildCreateParameter function assumes that the create request has been processed by the standard create dispatching list, which places the address of the KSOBJECT_CREATE_ITEM structure in the DriverContext member of Irp->Tail.Overlay. You can access this pointer by using the KSCREATE_ITEM_IRP_STORAGE(Irp) macro. This macro and related macros are included in ks.h.

Requirements

Target platform

Desktop

Header

Ks.h (include Ks.h)

 

 

Send comments about this topic to Microsoft