xref: /titanic_52/usr/src/man/man3dat/dat_strerror.3dat (revision ed22c7109fc5dd9e1b7a5d0333bdc7ad2718e2ab)
te
This manual page is derived from the DAT/uDAPL 1.2 specification.
Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
DAT_STRERROR 3DAT "Jul 16, 2004"
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 Standard: uDAPL, 1.1, 1.2
MT-Level Safe
SEE ALSO

libdat(3LIB), attributes(5)