Edit

WdfFileObjectGetFlags function (wdffileobject.h)

  • Article

[Applies to KMDF only]

The WdfFileObjectGetFlags method returns the flags that a specified framework file object contains.

Syntax

ULONG WdfFileObjectGetFlags(
  [in] WDFFILEOBJECT FileObject
);

Parameters

[in] FileObject

A handle to a framework file object.

Return value

WdfFileObjectGetFlags returns a bitwise OR of file object flags. The flag names have a format of FO_XXX and are defined in Wdm.h.

A bug check occurs if the driver supplies an invalid object handle.

Remarks

For more information about framework file objects, see Framework File Objects.

Examples

The following code example obtains the flags that a specified framework file object contains.

ULONG flags;

flags = WdfFileObjectGetFlags(fileObject);

Requirements

Requirement Value
Target Platform Universal
Minimum KMDF version 1.0
Header wdffileobject.h (include Wdf.h)
Library Wdf01000.sys (see Framework Library Versioning.)
IRQL <=DISPATCH_LEVEL
DDI compliance rules DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)