prg_mt_mutex_info_get()
Abstract
Obtains information about a mutex object.
Syntax
prg_mt_mutex_info_get (mutex_ptr, options_ptr, rank_ptr, locked_ptr, lock_id_ptr, description_ptr)
| Argument | Type | Description |
|---|---|---|
mutex_ptr |
PrgT_Mutex * |
Mutex object of interest. |
options_ptr |
int * |
Options value specified at creation time. |
rank_ptr |
int * |
Rank value specified at creation time. |
locked_ptr |
int * |
PRGC_TRUE if locked, PRGC_FALSE otherwise. |
lock_id_ptr |
int * |
If locked, id of the process that locked the mutex last. |
description_ptr |
const char * |
Description string specified at creation time. |
Return Type
PrgT_Compcode
PrgC_Compcode_Success if valid mutex, PrgC_Compcode_Failure otherwise
Header
prg_mt.h
Details
Allows one to obtain a set of information about a mutex object.