usr/src/man/man3gss/gss_duplicate_name.3gss

   1 '\" te
   2 .\" Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH GSS_DUPLICATE_NAME 3GSS "Jan 14, 2003"
   7 .SH NAME
   8 gss_duplicate_name \- create a copy of an internal name
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [\fIflag \&.\|.\|.\fR]  \fIfile\fR\&.\|.\|. \fB-lgss\fR [\fIlibrary \&.\|.\|.\fR]
  13 #include <gssapi/gssapi.h>
  14
  15 \fBOM_uint32\fR \fBgss_duplicate_name\fR(\fBOM_uint32 *\fR\fIminor_status\fR,
  16      \fBconst gss_name_t\fR \fIsrc_name\fR,\fBgss_name_t *\fR\fIdest_name\fR);
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The \fBgss_duplicate_name()\fR function creates an exact duplicate of the
  23 existing internal name \fIsrc_name\fR.  The new \fIdest_name\fR will be
  24 independent of the \fIsrc_name\fR. The \fIsrc_name\fR and \fIdest_name\fR must
  25 both be released, and the release of one does not affect the validity of the
  26 other.
  27 .SH PARAMETERS
  28 .sp
  29 .LP
  30 The parameter descriptions for \fBgss_duplicate_name()\fR follow:
  31 .sp
  32 .ne 2
  33 .na
  34 \fB\fIminor_status\fR\fR
  35 .ad
  36 .RS 16n
  37 A mechanism-specific status code.
  38 .RE
  39
  40 .sp
  41 .ne 2
  42 .na
  43 \fB\fIsrc_name\fR\fR
  44 .ad
  45 .RS 16n
  46 Internal name to be duplicated.
  47 .RE
  48
  49 .sp
  50 .ne 2
  51 .na
  52 \fB\fIdest_name\fR\fR
  53 .ad
  54 .RS 16n
  55 The resultant copy of \fIsrc_name\fR.  Storage associated with this name must
  56 be freed by the application after use with a call to
  57 \fBgss_release_name\fR(3GSS).
  58 .RE
  59
  60 .SH ERRORS
  61 .sp
  62 .LP
  63 The \fBgss_duplicate_name()\fR function may return the following status codes:
  64 .sp
  65 .ne 2
  66 .na
  67 \fB\fBGSS_S_COMPLETE\fR\fR
  68 .ad
  69 .RS 18n
  70 Successful completion.
  71 .RE
  72
  73 .sp
  74 .ne 2
  75 .na
  76 \fB\fBGSS_S_BAD_NAME\fR\fR
  77 .ad
  78 .RS 18n
  79 The \fIsrc_name\fR parameter was ill-formed.
  80 .RE
  81
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\fBGSS_S_FAILURE\fR\fR
  86 .ad
  87 .RS 18n
  88 The underlying mechanism detected an error for which no specific \fBGSS\fR
  89 status code is defined.  The mechanism-specific status code reported by means
  90 of the \fIminor_status\fR parameter details the error condition.
  91 .RE
  92
  93 .SH ATTRIBUTES
  94 .sp
  95 .LP
  96 See \fBattributes\fR(5) for descriptions of the following attributes:
  97 .sp
  98
  99 .sp
 100 .TS
 101 box;
 102 c | c
 103 l | l .
 104 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 105 _
 106 MT-Level        Safe
 107 .TE
 108
 109 .SH SEE ALSO
 110 .sp
 111 .LP
 112 \fBgss_release_name\fR(3GSS), \fBattributes\fR(5)
 113 .sp
 114 .LP
 115 \fISolaris Security for Developers Guide\fR