FltGetFilterInformation
TOC
Collapse the table of content
Expand the table of content

FltGetFilterInformation routine

The FltGetFilterInformation routine provides information about a minifilter driver.

Syntax


NTSTATUS FltGetFilterInformation(
  _In_  PFLT_FILTER              Filter,
  _In_  FILTER_INFORMATION_CLASS InformationClass,
  _Out_ PVOID                    Buffer,
  _In_  ULONG                    BufferSize,
  _Out_ PULONG                   BytesReturned
);

Parameters

Filter [in]

Opaque filter pointer for the caller.

InformationClass [in]

Type of information requested. This parameter can have one of the following values.

ValueMeaning

FilterFullInformation

The buffer pointed to by the Buffer parameter receives a FILTER_FULL_INFORMATION structure for the minifilter driver.

FilterAggregateBasicInformation

The buffer pointed to by the Buffer parameter receives a FILTER_AGGREGATE_BASIC_INFORMATION structure for the minifilter driver. This InformationClass value is available starting with Microsoft Windows Server 2003 SP1 and Windows XP SP2 with filter manager rollup. For more information on the filter manager rollup package for Windows XP SP2, see article 914882, " The filter manager rollup package for Windows XP SP2," in the Microsoft Knowledge Base.

FilterAggregateStandardInformation

The buffer pointed to by the Buffer parameter receives a FILTER_AGGREGATE_STANDARD_INFORMATION structure for the minifilter driver. The LegacyFilter portion of the structure is not utilized. This InformationClass value is available starting with Windows Vista.

 

Buffer [out]

Pointer to a caller-allocated buffer that receives the requested information. The type of the information returned in the buffer is defined by the InformationClass parameter.

BufferSize [in]

Size, in bytes, of the buffer that the Buffer parameter points to. The caller should set this parameter according to the given InformationClass value.

BytesReturned [out]

Pointer to a caller-allocated variable that receives the number of bytes returned in the buffer that Buffer points to. If the input value of BufferSize is too small, FltGetFilterInformation returns STATUS_BUFFER_TOO_SMALL and sets this variable to the number of bytes required to store the requested information. This parameter is required and cannot be NULL.

Return value

FltGetFilterInformation returns STATUS_SUCCESS or an appropriate NTSTATUS value, such as one of the following:

Return codeDescription
STATUS_BUFFER_TOO_SMALL

The buffer that the Buffer parameter points to is not large enough to store the requested information. This is an error code.

STATUS_INVALID_PARAMETER

An invalid value was specified for the InformationClass parameter. For example, if FilterAggregateStandardInformation is specified on an operating system prior to Windows Vista, the routine returns STATUS_INVALID_PARAMETER. This is an error code.

 

Requirements

Target platform

Universal

Header

Fltkernel.h (include FltKernel.h)

Library

FltMgr.lib

IRQL

<= APC_LEVEL

See also

FILTER_AGGREGATE_BASIC_INFORMATION
FILTER_AGGREGATE_STANDARD_INFORMATION
FILTER_FULL_INFORMATION
FltEnumerateFilterInformation
FltEnumerateInstanceInformationByFilter
FltEnumerateInstanceInformationByVolume
FltGetInstanceInformation

 

 

Send comments about this topic to Microsoft

Show:
© 2016 Microsoft