components/krb5/Solaris/man/gss_export_name.3gss
changeset 5490 9bf0bc57423a
child 7820 a2b9a7de9e1a
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/components/krb5/Solaris/man/gss_export_name.3gss	Wed Feb 24 10:43:57 2016 -0600
@@ -0,0 +1,117 @@
+'\" te
+.\" Copyright (c) 2003, 2011, Oracle and/or its affiliates. All rights reserved.
+.TH gss_export_name 3GSS "22 Aug 2011" "SunOS 5.12" "Generic Security Services API Library Functions"
+.SH NAME
+gss_export_name \- convert a mechanism name to export form
+.SH SYNOPSIS
+.LP
+.nf
+\fBcc\fR [\fIflag \&.\|.\|.\fR] \fIfile\fR\&.\|.\|. \fB-lgss\fR [\fIlibrary \&.\|.\|.\fR] 
+#include <gssapi/gssapi.h>
+
+\fBOM_uint32\fR \fBgss_export_name\fR(\fBOM_uint32 *\fR\fIminor_status\fR,
+     \fBconst gss_name_t\fR \fIinput_name\fR,\fBgss_buffer_t\fR \fIexported_name\fR);
+.fi
+
+.SH DESCRIPTION
+.sp
+.LP
+The \fBgss_export_name()\fR function allows a \fBGSS-API\fR internal name to be converted into a mechanism-specific name. The function produces a canonical contiguous string representation of a mechanism name, suitable for direct comparison, with \fBmemory\fR(3C), or for use in authorization functions, matching entries in an access-control list.  The \fIinput_name\fR parameter must specify a valid mechanism name, that is, an internal name generated by \fBgss_accept_sec_context\fR(3GSS) or by \fBgss_canonicalize_name\fR(3GSS).
+.SH PARAMETERS
+.sp
+.LP
+The parameter descriptions for \fBgss_export_name()\fR follow: 
+.sp
+.ne 2
+.mk
+.na
+\fB\fIminor_status\fR\fR
+.ad
+.RS 17n
+.rt  
+A mechanism-specific status code.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fIinput_name\fR\fR
+.ad
+.RS 17n
+.rt  
+The mechanism name to be exported.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fIexported_name\fR\fR
+.ad
+.RS 17n
+.rt  
+The canonical contiguous string form of \fIinput_name\fR. Storage associated with this string must freed by the application after use with \fBgss_release_buffer\fR(3GSS).
+.RE
+
+.SH ERRORS
+.sp
+.LP
+The \fBgss_export_name()\fR function may return the following status codes:
+.sp
+.ne 2
+.mk
+.na
+\fB\fBGSS_S_COMPLETE\fR\fR
+.ad
+.RS 21n
+.rt  
+Successful completion.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fBGSS_S_NAME_NOT_MN\fR\fR
+.ad
+.RS 21n
+.rt  
+The provided internal name was not a mechanism name.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fBGSS_S_FAILURE\fR\fR
+.ad
+.RS 21n
+.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_accept_sec_context\fR(3GSS), \fBgss_canonicalize_name\fR(3GSS), \fBgss_release_buffer\fR(3GSS)\fBmemory\fR(3C), \fBattributes\fR(5)
+.sp
+.LP
+\fI\fR