osResetFlags function

Declaration:

BOOL osResetFlags(
  HANDLE Handle,
  INDEX Mask,
  INDEX *Changed
);

Parameters:

Handle

The handle to the flags object.

Mask

A bitmask specifying which flags are to be reset to zero.

Changed

A pointer to a variable that receives the modification status. For each bit in the Mask, the corresponding bit in Changed is set to 1 if the flag was previously set (non-zero), or to 0 if it was already zero. This parameter may be set to NULL if this information is not required.

Return value:

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

Description:

This function resets the specified bits within a flags object to zero and reports which bits actually changed state. A bit in the Changed output variable is set to 1 only if the corresponding flag was non-zero prior to the reset operation.

For further details regarding flags objects, please 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, osGetFlags, osGetLastError, osSetFlags, TRUE

SpaceShadow documentation