FltGetNextExtraCreateParameter routine

The FltGetNextExtraCreateParameter routine returns a pointer to the next (or first) extra create parameter context structure (ECP) in a given ECP list.

Syntax


NTSTATUS FltGetNextExtraCreateParameter(
  _In_      PFLT_FILTER Filter,
  _In_      PECP_LIST   EcpList,
  _In_opt_  PVOID       CurrentEcpContext,
  _Out_opt_ LPGUID      NextEcpType,
  _Out_opt_ PVOID       *NextEcpContext,
  _Out_opt_ ULONG       *NextEcpContextSize
);

Parameters

Filter [in]

Opaque filter pointer to the minifilter driver. This pointer uniquely identifies the minifilter driver and remains constant as long as the minifilter driver is loaded.

EcpList [in]

Pointer to the ECP list to examine.

CurrentEcpContext [in, optional]

Optional pointer to an ECP in the given ECP list. If present, FltGetNextExtraCreateParameter returns the ECP after the CurrentEcpContext ECP. If CurrentEcpContext is NULL, FltGetNextExtraCreateParameter returns the first ECP in the list.

NextEcpType [out, optional]

Optional parameter that receives a pointer to the GUID of the returned ECP.

NextEcpContext [out, optional]

Optional parameter that receives a pointer to the returned ECP.

NextEcpContextSize [out, optional]

Optional parameter that receives the size, in bytes, of the returned ECP.

Return value

FltGetNextExtraCreateParameter returns one of the following NTSTATUS values:

Return codeDescription
STATUS_SUCCESS

An ECP was found in the EcpList ECP list.

STATUS_NOT_FOUND

The EcpList ECP list is empty or CurrentEcpContext is the last ECP in the list that is, there is no next ECP list element). Additionally, NextEcpContext is set to NULL and NextEcpContextSize is set to zero.

STATUS_INVALID_PARAMETER

The EcpList parameter is NULL.

 

Remarks

This routine is available starting with Windows Vista.

TheFltGetNextExtraCreateParameter routine processes an ECP list in a non-circular manner. That is, if the ECP pointed to by the CurrentEcpContext parameter is the last ECP element in the ECP list, there is no "next" ECP in the list and the routine returns STATUS_NOT_FOUND.

Requirements

Target platform

Universal

Version

This routine is available starting with Windows Vista.

Header

Fltkernel.h (include Fltkernel.h)

Library

FltMgr.lib

DLL

Fltmgr.sys

IRQL

<= APC_LEVEL

See also

ECP_LIST
FltAllocateExtraCreateParameter
FltAllocateExtraCreateParameterFromLookasideList
FltAllocateExtraCreateParameterList
FltCreateFileEx2
FltFreeExtraCreateParameter
FltFreeExtraCreateParameterList
FltGetEcpListFromCallbackData
FltInsertExtraCreateParameter
FltRemoveExtraCreateParameter
FltSetEcpListIntoCallbackData
IoCreateFileEx
Using GUIDs in Drivers

 

 

Send comments about this topic to Microsoft

Show: