RtkOpenMutex

RtkOpenMutex returns a handle to an existing named RTSS mutex.

Syntax

NTSTATUS RtkOpenMutex(
    [in]        RTSSINST RtssInst,
    [out]       PULONG MutexHandle,
    [ignored]   ULONG DesiredAccess,
    [ignored]   BOOLEAN InheritHandle,
    [in]        PUNICODE_STRING Name
);

Parameters

[in] RtssInst

An RTSSINST value returned from a call to RtkRtssAttach or RtkRtssAttachEx. Pass a valid RTSSINST value or the call will fail with STATUS_INVALID_PARAMETER.

[out]MutexHandle

A pointer to a handle that will receive a handle to the existing mutex object. Pass a valid pointer to a handle or the call will fail with STATUS_INVALID_PARAMETER.

[ignored] DesiredAccess

The requested access to the mutex object.

[ignored] InheritHandle

An indicator of whether the returned handle is inheritable.

[in] Name

A pointer to a PUNICODE_STRING specifying the name of the mutex object. The name is limited to 260 characters and can contain any character except the backslash path-separator character (\). Name comparison is case-sensitive.

Return Value

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

• STATUS_INVALID_PARAMETER
• STATUS_UNSUCCESSFUL
• STATUS_INVALID_HANDLE
• STATUS_NO_SUCH_DEVICE

Remarks

RtkOpenMutex enables multiple processes to open handles of the same mutex object. The function succeeds only if some process has already created the mutex with RtkCreateMutex. The calling process can use the returned handle in any function that requires a handle of a mutex object, such as a wait function.

Use RtkCloseHandle to close the handle. The system closes the handle automatically when the process terminates. The mutex object is destroyed when its last handle has been closed.

Requirements

See Also:

• RtkCloseHandle
• RtkCreateMutex
• RtkReleaseMutex