RtkCloseHandle

RtkCloseHandle closes an open object handle.

Syntax

NTSTATUS RtkCloseHandle(
    RTSSINST RtssInst,
    HANDLE Object
);

Parameters

RtssInst

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

Object

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

Return Value

Returns STATUS_SUCCESS on successful closing of the handle or one of the following NTSTATUS error codes on failure.

• 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 are finished using an object. On calling RtkCloseHandle it invalidates the specified object handle, decrements 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. A driver should call RtkCloseHandle once for each object it has created. If on calling RtkCloseHandle you receive a return of STATUS_UNSUCCESSFUL the handle is already invalidated.