osSetFlags function
Declaration:
BOOL osSetFlags(
  HANDLE Handle,
  INDEX Mask, 
  INDEX *Changed
);
Parameters:
Handle

A flags object handle.

Mask

Mask of the flags to be set to one.

Changed

Pointer to variable that receive a change status. When, before modification, a bit-flag was 1, the corresponding bit in Changed parameter will be set to zero, otherwise to 1. This pointer may be set to NULL when information is unnecessary.

Return value:

TRUE on success or FALSE on failure. Use osGetLastError function to obtain extended error information.

Description:

Function changes specified flags state to one, and returns change status. When, before modification, a bit-flag was 1, the corresponding bit in Changed parameter will be set to zero, otherwise to 1.

For more information on the flags see the flags objects section.

Function is available only, when the value of 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