.TH "globus_gram_client_attr" 3 "Version 14.6" "globus_gram_client" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_gram_client_attr \- GRAM Client Attribute Functions
.PP
 \- GRAM Client Attribute Functions\&.  

.SH SYNOPSIS
.br
.PP
.SS "Macros"

.in +1c
.ti -1c
.RI "#define \fBGLOBUS_GRAM_CLIENT_NO_ATTR\fP"
.br
.RI "Default GRAM client operation attribute\&. "
.in -1c
.SS "Typedefs"

.in +1c
.ti -1c
.RI "typedef void * \fBglobus_gram_client_attr_t\fP"
.br
.RI "GRAM client operation attribute\&. "
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "int \fBglobus_gram_client_attr_init\fP (\fBglobus_gram_client_attr_t\fP *attr)"
.br
.RI "Initialize a GRAM client attribute\&. "
.ti -1c
.RI "int \fBglobus_gram_client_attr_destroy\fP (\fBglobus_gram_client_attr_t\fP *attr)"
.br
.RI "Destroy a GRAM client attribute\&. "
.ti -1c
.RI "int \fBglobus_gram_client_attr_set_credential\fP (\fBglobus_gram_client_attr_t\fP attr, gss_cred_id_t credential)"
.br
.RI "Set a GRAM client attribute's security credential\&. "
.ti -1c
.RI "int \fBglobus_gram_client_attr_get_credential\fP (\fBglobus_gram_client_attr_t\fP attr, gss_cred_id_t *credential)"
.br
.RI "Get a GRAM client attribute's security credential\&. "
.ti -1c
.RI "int \fBglobus_gram_client_attr_set_delegation_mode\fP (\fBglobus_gram_client_attr_t\fP attr, globus_io_secure_delegation_mode_t mode)"
.br
.RI "Set a GRAM client attribute's delegation mode\&. "
.ti -1c
.RI "int \fBglobus_gram_client_attr_get_delegation_mode\fP (\fBglobus_gram_client_attr_t\fP attr, globus_io_secure_delegation_mode_t *mode)"
.br
.RI "Get a GRAM client attribute's security credential\&. "
.in -1c
.SH "Detailed Description"
.PP 
GRAM Client Attribute Functions\&. 


.SH "Macro Definition Documentation"
.PP 
.SS "#define GLOBUS_GRAM_CLIENT_NO_ATTR"

.PP
Default GRAM client operation attribute\&. The GLOBUS_GRAM_CLIENT_NO_ATTR macro defines a constant for use when a user of the GRAM client API does not want to specify any non-default GRAM attributes\&. 
.SH "Typedef Documentation"
.PP 
.SS "typedef void* \fBglobus_gram_client_attr_t\fP"

.PP
GRAM client operation attribute\&. The \fBglobus_gram_client_attr_t\fP type is an opaque type describing GRAM attributes\&. It can be accessed or modified by functions in the \fBGRAM Client Attribute Functions\fP documentation\&. 
.SH "Function Documentation"
.PP 
.SS "int globus_gram_client_attr_destroy (\fBglobus_gram_client_attr_t\fP * attr)"

.PP
Destroy a GRAM client attribute\&. The \fBglobus_gram_client_attr_destroy()\fP function destroys and frees a GRAM client attribute\&. After this function returns, the value pointed to by \fIattr\fP is no longer valid and must not be used\&.
.PP
\fBParameters\fP
.RS 4
\fIattr\fP A pointer to the attribute to destroy\&. All data associated with the attribute will be freed and it will be an invalid attribute\&.
.RE
.PP
\fBReturns\fP
.RS 4
Upon success, \fBglobus_gram_client_attr_destroy()\fP destroys the attribute pointed to by the \fIattr\fP parameter and sets it to an invalid state\&. If an error occurs, \fBglobus_gram_client_attr_destroy()\fP returns an integer error code and value of \fIattr\fP is unchanged\&.
.RE
.PP
\fBReturn values\fP
.RS 4
\fIGLOBUS_SUCCESS\fP Success 
.br
\fIGLOBUS_GRAM_PROTOCOL_ERROR_INVALID_ATTR\fP Invalid attribute
.RE
.PP
\fBSee also\fP
.RS 4
\fBglobus_gram_client_attr_init()\fP 
.RE
.PP

.SS "int globus_gram_client_attr_get_credential (\fBglobus_gram_client_attr_t\fP attr, gss_cred_id_t * credential)"

.PP
Get a GRAM client attribute's security credential\&. The \fBglobus_gram_client_attr_get_credential()\fP function gets the value of the \fBcredential\fP in an attribute and modifies the \fIcredential\fP parameter to point to it\&. This is a shallow copy\&.
.PP
\fBParameters\fP
.RS 4
\fIattr\fP The attribute set to query for its \fIcredential\fP\&. 
.br
\fIcredential\fP An output parameter that will be initialized to point to the GSSAPI credential which the \fIattr\fP is currently using\&.
.RE
.PP
\fBReturns\fP
.RS 4
Upon success, \fBglobus_gram_client_attr_get_credential()\fP modifies the the value pointed to by the \fIcredential\fP parameter to be the same credential as that being used by the attribute named by the \fIattr\fP parameter and returns \fIGLOBUS_SUCCESS\fP\&. If an error occurs, \fBglobus_gram_client_attr_get_credential()\fP returns an integer error code and the value pointed to by the \fIcredential\fP parameter is undefined\&.
.RE
.PP
\fBReturn values\fP
.RS 4
\fIGLOBUS_SUCCESS\fP Success 
.br
\fIGLOBUS_GRAM_PROTOCOL_ERROR_INVALID_ATTR\fP Invalid attribute 
.br
\fIGLOBUS_GRAM_PROTOCOL_ERROR_NULL_PARAMETER\fP Null parameter
.RE
.PP
\fBSee also\fP
.RS 4
\fBglobus_gram_client_attr_set_credential()\fP 
.RE
.PP

.SS "int globus_gram_client_attr_get_delegation_mode (\fBglobus_gram_client_attr_t\fP attr, globus_io_secure_delegation_mode_t * mode)"

.PP
Get a GRAM client attribute's security credential\&. The \fBglobus_gram_client_attr_get_delegation_mode()\fP function gets the value of the \fBdelegation_mode\fP in an attribute and modifies the \fImode\fP parameter to point to its value\&.
.PP
\fBParameters\fP
.RS 4
\fIattr\fP The attribute set to query for its \fIdelegation_mode\fP\&. 
.br
\fImode\fP An output parameter that will be set to point to the delegation mode which the \fIattr\fP is currently using\&.
.RE
.PP
\fBReturns\fP
.RS 4
Upon success, \fBglobus_gram_client_attr_get_delegation_mode()\fP modifies the the value pointed to by the \fImode\fP parameter as described above and returns \fIGLOBUS_SUCCESS\fP\&. If an error occurs, \fBglobus_gram_client_attr_get_delegation_mode()\fP returns an integer error code and the value pointed to by the \fImode\fP parameter is undefined\&.
.RE
.PP
\fBReturn values\fP
.RS 4
\fIGLOBUS_SUCCESS\fP Success 
.br
\fIGLOBUS_GRAM_PROTOCOL_ERROR_INVALID_ATTR\fP Invalid attribute 
.br
\fIGLOBUS_GRAM_PROTOCOL_ERROR_NULL_PARAMETER\fP Null parameter
.RE
.PP
\fBSee also\fP
.RS 4
\fBglobus_gram_client_attr_get_delegation_mode()\fP 
.RE
.PP

.SS "int globus_gram_client_attr_init (\fBglobus_gram_client_attr_t\fP * attr)"

.PP
Initialize a GRAM client attribute\&. The \fBglobus_gram_client_attr_init()\fP function creates a new opaque structure that can be used to specify custom attributes for performing GRAM client operations\&.
.PP
\fBParameters\fP
.RS 4
\fIattr\fP An output parameter which will be set to the newly initialized attribute\&.
.RE
.PP
\fBReturns\fP
.RS 4
Upon success, \fBglobus_gram_client_attr_init()\fP modifies the \fIattr\fP parameter to point to a new GRAM client attribute and returns \fIGLOBUS_SUCCESS\fP\&. If an error occurs, \fBglobus_gram_client_attr_init()\fP returns an integer error code and value of \fIattr\fP is undefined\&.
.RE
.PP
\fBReturn values\fP
.RS 4
\fIGLOBUS_SUCCESS\fP Success 
.br
\fIGLOBUS_GRAM_PROTOCOL_ERROR_INVALID_ATTR\fP Invalid attribute 
.br
\fIGLOBUS_GRAM_PROTOCOL_ERROR_MALLOC_FAILED\fP Out of memory
.RE
.PP
\fBSee also\fP
.RS 4
\fBglobus_gram_client_attr_destroy()\fP 
.RE
.PP

.SS "int globus_gram_client_attr_set_credential (\fBglobus_gram_client_attr_t\fP attr, gss_cred_id_t credential)"

.PP
Set a GRAM client attribute's security credential\&. The \fBglobus_gram_client_attr_set_credential()\fP function sets the value of the \fBcredential\fP in an attribute to the GSSAPI credential named by the \fIcredential\fP parameter\&. This is done as a shallow copy, so the value of \fIcredential\fP must not be freed until the attribute will no longer be used\&.
.PP
\fBParameters\fP
.RS 4
\fIattr\fP The attribute set to modify to use the credential named by the \fIcredential\fP parameter\&. 
.br
\fIcredential\fP The GSSAPI credential to use with the attribute named by the \fIattr\fP parameter\&. This may be \fIGSS_C_NO_CREDENTIAL\fP to set the attribute to use the default security credential\&.
.RE
.PP
\fBReturns\fP
.RS 4
Upon success, \fBglobus_gram_client_attr_set_credential()\fP modifies the the attribute pointed to by the \fIattr\fP parameter to use the credential specified by the \fIcredential\fP parameter and returns \fIGLOBUS_SUCCESS\fP\&. If an error occurs, \fBglobus_gram_client_attr_set_credential()\fP returns an integer error code and the attribute named by \fIattr\fP is unchanged\&.
.RE
.PP
\fBReturn values\fP
.RS 4
\fIGLOBUS_GRAM_PROTOCOL_ERROR_INVALID_ATTR\fP An invalid attribute set was passed to this function\&.
.RE
.PP
\fBSee also\fP
.RS 4
\fBglobus_gram_client_attr_get_credential()\fP 
.RE
.PP

.SS "int globus_gram_client_attr_set_delegation_mode (\fBglobus_gram_client_attr_t\fP attr, globus_io_secure_delegation_mode_t mode)"

.PP
Set a GRAM client attribute's delegation mode\&. The \fBglobus_gram_client_attr_set_delegation_mode()\fP function sets the value of the \fBdelegation_mode\fP in an attribute to the delegation mode in the \fImode\fP parameter\&.
.PP
The GRAM client supports the following delegation modes:
.IP "\(bu" 2
\fBGLOBUS_IO_SECURE_DELEGATION_MODE_LIMITED_PROXY\fP 
.IP "\(bu" 2
\fBGLOBUS_IO_SECURE_DELEGATION_MODE_FULL_PROXY\fP 
.PP
.PP
\fBParameters\fP
.RS 4
\fIattr\fP The attribute set to modify to use the delegation mode in the \fImode\fP parameter\&. 
.br
\fImode\fP The new value of the delegation mode\&.
.RE
.PP
\fBReturns\fP
.RS 4
Upon success, \fBglobus_gram_client_attr_set_delegation_mode()\fP modifies the the attribute named by the \fIattr\fP parameter to use the delegation mode in the \fImode\fP parameter and returns GLOBUS_SUCCESS\&. If an error occurs, \fBglobus_gram_client_attr_set_delegation_mode()\fP returns an integer error code and the \fIdelegation_mode\fP attribute value is unchanged\&.
.RE
.PP
\fBReturn values\fP
.RS 4
\fIGLOBUS_SUCCESS\fP Success 
.br
\fIGLOBUS_GRAM_PROTOCOL_ERROR_INVALID_ATTR\fP Invalid attribute
.RE
.PP
\fBSee also\fP
.RS 4
\fBglobus_gram_client_attr_get_delegation_mode()\fP 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for globus_gram_client from the source code\&.