RtkOpenSharedMemory

RtkOpenSharedMemory opens a named physical-mapping object.

Syntax

HANDLE RtkOpenSharedMemory(
    RTSSINST RtssInst,
    PULONG pErrorCode,
    DWORD DesiredAccess,
    BOOL bInheritHandle,
    PUNICODE_STRING lpName,
    VOID ** location
);

Parameters

RtssInst

An RTSSINST value returned from a call to RtkRtssAttach.

pErrorCode

A pointer to a location where additional error information may be returned. This location need not be defined; the user may pass a NULL value. If defined, this location is set to NULL if no error occurred.

DesiredAccess

The access mode. The RTSS environment always grants read and write access. This parameter can be one of the following values:

SHM_MAP_WRITE — Read-write access. The target shared memory object must have been created with PAGE_READWRITE protection. A read-write view of the shared memory is mapped.
SHM_MAP_READ — Read-only access. The target shared memory object must have been created with PAGE_READWRITE or PAGE_READ protection. A read-only view of the shared memory is mapped.

bInheritHandle

Ignored.

lpName

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

location

A pointer to a location where the virtual address of the mapping will be stored.

Return Values

An open handle to the specified shared memory object if the function succeeds, NULL if the function fails

Remarks

The handle that RtkOpenSharedMemory returns can be used with RtkCloseHandle to decrement the reference count to the shared memory object. When the reference count is zero, the object is removed from the system.

Requirements

Header	Rtkapi.h
Library	rtx_rtk.lib