usr/src/man/man3dat/dat_strerror.3dat

   1 '\" te
   2 .\" This manual page is derived from the DAT/uDAPL 1.2 specification.
   3 .\" Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH DAT_STRERROR 3DAT "Jul 16, 2004"
   8 .SH NAME
   9 dat_strerror \- convert a DAT return code into human readable strings
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-ldat\fR [ \fIlibrary\fR\&.\|.\|. ]
  14 #include <\fBdat/udat.h\fR>
  15
  16 DAT_RETURN
  17     dat_strerror(
  18     IN    DAT_RETURN    return,
  19     OUT   const char    **major_message,
  20     OUT   const char    **minor_message
  21     )
  22 .fi
  23
  24 .SH PARAMETERS
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fIreturn\fR\fR
  29 .ad
  30 .RS 11n
  31 DAT function return value.
  32 .RE
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fImessage\fR\fR
  38 .ad
  39 .RS 11n
  40 A pointer to a character string for the return.
  41 .RE
  42
  43 .SH DESCRIPTION
  44 .sp
  45 .LP
  46 The \fBdat_strerror()\fR function converts a DAT return code into human
  47 readable strings. The \fImajor_message\fR is a string-converted
  48 \fBDAT_TYPE_STATUS\fR, while \fIminor_message\fR is a string-converted
  49 \fBDAT_SUBTYPE_STATUS\fR. If the return of this function is not
  50 \fBDAT_SUCCESS\fR, the values of \fImajor_message\fR and \fIminor_message\fR
  51 are not defined.
  52 .sp
  53 .LP
  54 If an undefined \fBDAT_RETURN\fR value was passed as the return parameter, the
  55 operation fails with \fBDAT_INVALID_PARAMETER\fR returned. The operation
  56 succeeds when \fBDAT_SUCCESS\fR is passed in as the return parameter.
  57 .SH RETURN VALUES
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fBDAT_SUCCESS\fR\fR
  62 .ad
  63 .RS 25n
  64 The operation was successful.
  65 .RE
  66
  67 .sp
  68 .ne 2
  69 .na
  70 \fB\fBDAT_INVALID_PARAMETER\fR\fR
  71 .ad
  72 .RS 25n
  73 Invalid parameter. The \fIreturn\fR value is invalid.
  74 .RE
  75
  76 .SH ATTRIBUTES
  77 .sp
  78 .LP
  79 See \fBattributes\fR(5) for descriptions of the following attributes:
  80 .sp
  81
  82 .sp
  83 .TS
  84 box;
  85 c | c
  86 l | l .
  87 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  88 _
  89 Interface Stability     Standard: uDAPL, 1.1, 1.2
  90 _
  91 MT-Level        Safe
  92 .TE
  93
  94 .SH SEE ALSO
  95 .sp
  96 .LP
  97 \fBlibdat\fR(3LIB), \fBattributes\fR(5)