stHandleAlloc function

stHandleAlloc Function

Declaration:

BOOL stHandleAlloc(
  HANDLE *Handle,
  PVOID Info
);

Parameters:

Handle

Pointer to a variable that receives the allocated handle value.

Info

Information associated with the handle (cannot be NULL).

Return value:

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

Description:

This function allocates a new, unique handle. It returns FALSE in the event of a failure. A failure may occur if the maximum number of available handles, defined by the ST_MAX_HANDLE_COUNT constant, has been reached. When the handle is no longer required, the stHandleRelease function is used by the system to release the handle.

This function is utilized internally by SpaceShadow products and should not be used by the user. It may change in future releases.

Version:	1.0
Header file:	ST_Handle.h (include ST_API.h)
See also:	BOOL, FALSE, HANDLE, handle management, NULL, PVOID, ST_MAX_HANDLE_COUNT, stHandleRelease, stGetLastError, TRUE

SpaceShadow documentation