components/krb5/Solaris/man/gss_duplicate_name.3gss
author Will Fiveash <will.fiveash@oracle.com>
Wed, 24 Feb 2016 10:43:57 -0600
changeset 5490 9bf0bc57423a
child 7820 a2b9a7de9e1a
permissions -rw-r--r--
PSARC/2015/144 Kerberos 1.13 Delivery to Userland 19153034 Add MIT Kerberos to the Userland Consolidation

'\" te
.\" Copyright (c) 2003, 2011, Oracle and/or its affiliates. All rights reserved.
.TH gss_duplicate_name 3GSS "22 Aug 2011" "SunOS 5.12" "Generic Security Services API Library Functions"
.SH NAME
gss_duplicate_name \- create a copy of an internal name
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [\fIflag \&.\|.\|.\fR]  \fIfile\fR\&.\|.\|. \fB-lgss\fR [\fIlibrary \&.\|.\|.\fR] 
#include <gssapi/gssapi.h>

\fBOM_uint32\fR \fBgss_duplicate_name\fR(\fBOM_uint32 *\fR\fIminor_status\fR,
     \fBconst gss_name_t\fR \fIsrc_name\fR,\fBgss_name_t *\fR\fIdest_name\fR);
.fi

.SH DESCRIPTION
.sp
.LP
The \fBgss_duplicate_name()\fR function creates an exact duplicate of the existing internal name \fIsrc_name\fR.  The new \fIdest_name\fR will be independent of the \fIsrc_name\fR. The \fIsrc_name\fR and \fIdest_name\fR must both be released, and the release of one does not affect the validity of the other.
.SH PARAMETERS
.sp
.LP
The parameter descriptions for \fBgss_duplicate_name()\fR follow:
.sp
.ne 2
.mk
.na
\fB\fIminor_status\fR\fR
.ad
.RS 16n
.rt  
A mechanism-specific status code.
.RE

.sp
.ne 2
.mk
.na
\fB\fIsrc_name\fR\fR
.ad
.RS 16n
.rt  
Internal name to be duplicated.
.RE

.sp
.ne 2
.mk
.na
\fB\fIdest_name\fR\fR
.ad
.RS 16n
.rt  
The resultant copy of \fIsrc_name\fR.  Storage associated with this name must be freed by the application after use with a call to \fBgss_release_name\fR(3GSS).
.RE

.SH ERRORS
.sp
.LP
The \fBgss_duplicate_name()\fR function may return the following status codes:
.sp
.ne 2
.mk
.na
\fB\fBGSS_S_COMPLETE\fR\fR
.ad
.RS 18n
.rt  
Successful completion.
.RE

.sp
.ne 2
.mk
.na
\fB\fBGSS_S_BAD_NAME\fR\fR
.ad
.RS 18n
.rt  
The \fIsrc_name\fR parameter was ill-formed.
.RE

.sp
.ne 2
.mk
.na
\fB\fBGSS_S_FAILURE\fR\fR
.ad
.RS 18n
.rt  
The underlying mechanism detected an error for which no specific \fBGSS\fR status code is defined.  The mechanism-specific status code reported by means of the \fIminor_status\fR parameter details the error condition.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
MT-LevelSafe
.TE

.SH SEE ALSO
.sp
.LP
\fBgss_release_name\fR(3GSS), \fBattributes\fR(5)
.sp
.LP