man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: July 2014
 
 

dat_strerror(3DAT)

Name

dat_strerror - convert a DAT return code into human readable strings

Synopsis

cc [ flag… ] file–ldat [ library… ] 
#include <dat/udat.h>

DAT_RETURN
    dat_strerror(
    IN    DAT_RETURN    return,
    OUT   const char    **major_message,
    OUT   const char    **minor_message
    )

Parameters

return

DAT function return value.

message

A pointer to a character string for the return.

Description

The dat_strerror() function converts a DAT return code into human readable strings. The major_message is a string-converted DAT_TYPE_STATUS, while minor_message is a string-converted DAT_SUBTYPE_STATUS. If the return of this function is not DAT_SUCCESS, the values of major_message and minor_message are not defined.

If an undefined DAT_RETURN value was passed as the return parameter, the operation fails with DAT_INVALID_PARAMETER returned. The operation succeeds when DAT_SUCCESS is passed in as the return parameter.

Return Values

DAT_SUCCESS

The operation was successful.

DAT_INVALID_PARAMETER

Invalid parameter. The return value is invalid.

Attributes

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Interface Stability
Committed
MT-Level
Safe
Standard
uDAPL, 1.1, 1.2

See Also

libdat(3LIB), attributes(5)