RtCloseHandle

RtCloseHandle closes an open RTSS object handle.

Syntax

Copy
BOOL RtCloseHandle(
    [in]    HANDLE hObject
);

Parameters

[in] hObject

An open object handle.

Return Value

If the function succeeds, it returns TRUE. If the function fails, it returns FALSE. GetLastError to obtain an error code.

Remarks

RtCloseHandle closes handles to the following RTSS objects:

RtCloseHandle invalidates the specified object handle, decreases the object's handle count, and performs object retention checks. Once the last handle to an object is closed, the object is removed from the operating system.

Threads must be closed with RtCloseHandle.

Requirements

Minimum supported version Header Library

wRTOS 1.0 SDK

RtApi.h

RtApi.lib (Windows), Startup.lib (RTSS)

See Also: