FsRtlGetNextExtraCreateParameter routine

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

Syntax


NTSTATUS FsRtlGetNextExtraCreateParameter(
  _In_      PECP_LIST EcpList,
  _In_opt_  PVOID     CurrentEcpContext,
  _Out_opt_ LPGUID    NextEcpType,
  _Out_     PVOID     *NextEcpContext,
  _Out_opt_ ULONG     *NextEcpContextSize
);

Parameters

EcpList [in]

Pointer to the ECP list to examine.

CurrentEcpContext [in, optional]

Optional pointer to an ECP context structure in the given ECP list. If present, FsRtlGetNextExtraCreateParameter returns a pointer to the ECP after the CurrentEcpContext ECP context structure. If CurrentEcpContext is NULL, FsRtlGetNextExtraCreateParameter returns the first ECP context structure in the list.

NextEcpType [out, optional]

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

NextEcpContext [out]

Optional parameter that receives a pointer to the returned ECP context structure.

NextEcpContextSize [out, optional]

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

Return value

FsRtlGetNextExtraCreateParameter returns one of the following NTSTATUS values:

Return codeDescription
STATUS_SUCCESS

FsRtlGetNextExtraCreateParameter found an ECP context structure 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

TheFsRtlGetNextExtraCreateParameter routine processes an ECP list in a non-circular manner. That is, if the ECP context structure pointed to by the CurrentEcpContext parameter is the last 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

The FsRtlGetNextExtraCreateParameter routine is available starting with Windows Vista.

Header

Ntifs.h (include Ntifs.h)

Library

NtosKrnl.lib

DLL

NtosKrnl.exe

IRQL

<= APC_LEVEL

See also

ECP_LIST
FltAllocateExtraCreateParameter
FltAllocateExtraCreateParameterFromLookasideList
FltAllocateExtraCreateParameterList
FltCreateFileEx2
FltFreeExtraCreateParameter
FltFreeExtraCreateParameterList
FltGetEcpListFromCallbackData
FltInsertExtraCreateParameter
FltRemoveExtraCreateParameter
FltSetEcpListIntoCallbackData
IoCreateFileEx

 

 

Send comments about this topic to Microsoft

Show: