osSetFlags function

osSetFlags function

Declaration:

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

Parameters:

Handle

The handle to the flags object.

Mask

A bitmask specifying which flags are to be set to one.

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 zero, or to 0 if it was already set to 1. 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 sets the specified bits within a flags object to one and reports which bits actually changed state. A bit in the Changed output variable is set to 1 only if the corresponding flag was zero prior to the set operation.

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, osGetFlags, osGetLastError, osResetFlags, TRUE

SpaceShadow documentation