Changes the object name in a mutex object.

1  –  C Binding

    #include <pthread.h>

    int
    pthread_mutex_setname_np (
             pthread_mutex_t   *mutex,
             const char   *name,
             void   *mbz);

2  –  Arguments

 mutex

    Address of the mutex object whose object name is to be changed.

 name

    Object name value to copy into the mutex object.

 mbz

    Reserved for future use. The value must be zero (0).

3  –  Description

    This routine changes the object name in the mutex object
    specified by the mutex argument to the value specified by the
    name argument. To set a new mutex object's object name, call this
    routine immediately after initializing the mutex object.

    The object name is a C language string and provides an identifier
    that is meaningful to a person debugging a multithreaded
    application. The maximum number of characters in the object name
    is 31.

4  –  Return Values

    If an error condition occurs, this routine returns an integer
    value indicating the type of error. Possible return values are as
    follows:

    Return      Description

    0           Successful completion.
    [EINVAL]    The value specified by mutex is not a valid mutex, or
                the length in characters of name exceeds 31.
    [ENOMEM]    Insufficient memory to create a copy of the object
                name string.

5  –  Associated Routines

       pthread_mutex_getname_np()