The OpenSemaphore function returns a handle of an existing named semaphore object.
HANDLE OpenSemaphore(
| DWORD dwDesiredAccess, | // access flag |
| BOOL bInheritHandle, | // inherit flag |
| LPCTSTR lpName | // pointer to semaphore-object name |
| ); |
Parameters
dwDesiredAccess
Specifies the requested access to the semaphore object. For systems that support object security, the function fails if the security descriptor of the specified object does not permit the requested access for the calling process.
This parameter can be any combination of the following values:
| Access | Description |
| SEMAPHORE_ALL_ACCESS | Specifies all possible access flags for the semaphore object. |
| SEMAPHORE_MODIFY_STATE | Enables use of the semaphore handle in the ReleaseSemaphore function to modify the semaphore's count. |
| SYNCHRONIZE | Windows NT only: Enables use of the semaphore handle in any of the wait functions to wait for the semaphore's state to be signaled. |
bInheritHandle
Specifies whether the returned handle is inheritable. If TRUE, a process created by the CreateProcess function can inherit the handle; otherwise, the handle cannot be inherited.
lpName
Points to a null-terminated string that names the semaphore to be opened. Name comparisons are case sensitive.
Return Values
If the function succeeds, the return value is a handle of the semaphore object.
If the function fails, the return value is NULL. To get extended error information, call GetLastError.
Remarks
The OpenSemaphore function enables multiple processes to open handles of the same semaphore object. The function succeeds only if some process has already created the semaphore by using the CreateSemaphore function. The calling process can use the returned handle in any function that requires a handle of a semaphore object, such as the wait functions, subject to the limitations of the access specified in the dwDesiredAccess parameter.
The handle can be duplicated by using the DuplicateHandle function. Use the CloseHandle function to close the handle. The system closes the handle automatically when the process terminates. The semaphore object is destroyed when its last handle has been closed.
See Also
CloseHandle, CreateSemaphore, DuplicateHandle, ReleaseSemaphore