osGetFlags function

osGetFlags function

Declaration:

BOOL osGetFlags(
  HANDLE Handle
  INDEX *State
);

Parameters:

Handle

The handle to the flags object.

State

A pointer to a variable that will receive the current state of the flags.

Return value:

TRUE on success; FALSE on failure. Call the osGetLastError function to retrieve extended error information.

Description:

This function retrieves the current state of all bit-flags within the specified flags object.

For further information regarding flags objects, refer to the flags objects section.

This function is available only when the OS_USE_FLAGS constant is set to 1.

Version:	1.0
Header file:	OS_Flags.h (include OS_API.h)
See also:	BOOL, FALSE, flags, HANDLE, INDEX, OS_USE_FLAGS, osCreateFlags, osGetLastError, osResetFlags, osSetFlags, TRUE

SpaceShadow documentation