stHandleInfo function

stHandleInfo Function

Declaration:

PVOID stHandleInfo(
  HANDLE Handle,
  PVOID Info
);

Parameters:

Handle

The handle value.

Info

If set to NULL, the function returns the information associated with the handle. If not NULL, the function overwrites the current information associated with the handle with the value specified in this parameter.

Return value:

On success, the function returns the current information associated with the handle. If the data is overwritten, the new value is returned. On failure, NULL is returned. Use the stGetLastError function to obtain extended error information.

Description:

This function retrieves or modifies the information associated with a specified handle. This information is a pointer of type PVOID. It is utilized by SpaceShadow products to determine which object is associated with a specific handle.

To retrieve handle information, set the Info parameter to NULL. In this case, the function returns the associated information. To update the handle information, provide a non-NULL value in the Info parameter; the function will overwrite the existing data and return the new value. The function returns NULL if the specified handle is invalid.

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, stGetLastError, TRUE

SpaceShadow documentation