RtkCloseHandle

RtkCloseHandle closes an open object handle.

Syntax

NTSTATUS RtkCloseHandle(
    [in]    RTSSINST RtssInst,
    [in]    HANDLE Object
);

Parameters

[in] RtssInst

An RTSSINST type returned from a call to RtkRtssAttach or RtkRtssAttachEx.

[in] Object

A handle to an open object that you wish to close.

Return Value

If the function succeeds, it returns STATUS_SUCCESS. If the function fails, it returns one of the following NTSTATUS error codes:

• STATUS_UNSUCCESSFUL
• STATUS_INVALID_PARAMETER

Remarks

RtkCloseHandle closes handles to the following RTSS objects:

• Mutex
• Semaphore
• Shared memory
• Event

RtkCloseHandle should be called when you finish using an object. On calling RtkCloseHandle, it invalidates the specified object handle, decreases the object's handle reference count, and performs object retention checks. Once the last handle to an object is closed, the object is removed from the operating system. A driver should call RtkCloseHandle once for each object it has created. If you receive a return of STATUS_UNSUCCESSFUL when calling RtkCloseHandle, it indicates the handle is already invalidated.