.TH "globus_gsi_cred_handle_attrs" 3 "Version 8.4" "globus_gsi_credential" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_gsi_cred_handle_attrs \- Credential Handle Attributes
.PP
 \- Credential Handle Attributes\&.  

.SH SYNOPSIS
.br
.PP
.SS "Typedefs"

.in +1c
.ti -1c
.RI "typedef struct globus_l_gsi_cred_handle_attrs_s * \fBglobus_gsi_cred_handle_attrs_t\fP"
.br
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_handle_attrs_init\fP (\fBglobus_gsi_cred_handle_attrs_t\fP *handle_attrs)"
.br
.RI "Initialize credential handle attributes\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_handle_attrs_destroy\fP (\fBglobus_gsi_cred_handle_attrs_t\fP handle_attrs)"
.br
.RI "Destroy credential handle attributes\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_handle_attrs_copy\fP (\fBglobus_gsi_cred_handle_attrs_t\fP source, \fBglobus_gsi_cred_handle_attrs_t\fP *dest)"
.br
.RI "Copy credential handle attributes\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_handle_attrs_set_ca_cert_dir\fP (\fBglobus_gsi_cred_handle_attrs_t\fP handle_attrs, const char *ca_cert_dir)"
.br
.RI "Set the CA certificate directory\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_handle_attrs_get_ca_cert_dir\fP (\fBglobus_gsi_cred_handle_attrs_t\fP handle_attrs, char **ca_cert_dir)"
.br
.RI "Get the CA certificate directory\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_handle_attrs_set_search_order\fP (\fBglobus_gsi_cred_handle_attrs_t\fP handle_attrs, \fBglobus_gsi_cred_type_t\fP search_order[])"
.br
.RI "Set the search order\&. "
.ti -1c
.RI "globus_result_t \fBglobus_gsi_cred_handle_attrs_get_search_order\fP (\fBglobus_gsi_cred_handle_attrs_t\fP handle_attrs, \fBglobus_gsi_cred_type_t\fP **search_order)"
.br
.RI "Get the search order\&. "
.in -1c
.SH "Detailed Description"
.PP 
Credential Handle Attributes\&. 

Create/Destroy/Modify GSI Credential Handle Attributes\&.
.PP
Within the Globus GSI Credential Library, all credential handles contain a attribute structure, which in turn contains handle instance independent attributes\&.
.PP
This section defines operations to create, modify and destroy GSI Credential handle attributes\&. 
.SH "Typedef Documentation"
.PP 
.SS "typedef struct globus_l_gsi_cred_handle_attrs_s* \fBglobus_gsi_cred_handle_attrs_t\fP"
Credential Handle Attributes\&.
.PP
Credential handle attributes provide a set of immutable parameters for a credential handle
.PP
\fBSee also\fP
.RS 4
\fBglobus_gsi_cred_handle_init\fP 
.RE
.PP

.SH "Function Documentation"
.PP 
.SS "globus_result_t globus_gsi_cred_handle_attrs_copy (\fBglobus_gsi_cred_handle_attrs_t\fP source, \fBglobus_gsi_cred_handle_attrs_t\fP * dest)"

.PP
Copy credential handle attributes\&. Copy the Credential Handle Attributes\&.
.PP
\fBParameters\fP
.RS 4
\fIsource\fP The handle attribute to be copied 
.br
\fIdest\fP The copy 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCESS unless there was an error, in which case an error object is returned\&. 
.RE
.PP

.SS "globus_result_t globus_gsi_cred_handle_attrs_destroy (\fBglobus_gsi_cred_handle_attrs_t\fP handle_attrs)"

.PP
Destroy credential handle attributes\&. Destroy the Credential Handle Attributes\&. This function does some cleanup and deallocation of the handle attributes\&.
.PP
\fBParameters\fP
.RS 4
\fIhandle_attrs\fP The handle attributes to destroy
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS 
.RE
.PP

.SS "globus_result_t globus_gsi_cred_handle_attrs_get_ca_cert_dir (\fBglobus_gsi_cred_handle_attrs_t\fP handle_attrs, char ** ca_cert_dir)"

.PP
Get the CA certificate directory\&. Get the trusted CA certificate directory
.PP
\fBParameters\fP
.RS 4
\fIhandle_attrs\fP the credential handle attributes to get the trusted ca cert directory from 
.br
\fIca_cert_dir\fP the trusted ca certificates directory 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS if no errors occurred\&. In case of a null handle_attrs or pointer to ca_cert_dir, an error object id is returned 
.RE
.PP

.SS "globus_result_t globus_gsi_cred_handle_attrs_get_search_order (\fBglobus_gsi_cred_handle_attrs_t\fP handle_attrs, \fBglobus_gsi_cred_type_t\fP ** search_order)"

.PP
Get the search order\&. Get the search order of the handle attributes
.PP
\fBParameters\fP
.RS 4
\fIhandle_attrs\fP The handle attributes to get the search order from 
.br
\fIsearch_order\fP The search_order of the handle attributes 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS unless handle_attrs is null 
.RE
.PP

.SS "globus_result_t globus_gsi_cred_handle_attrs_init (\fBglobus_gsi_cred_handle_attrs_t\fP * handle_attrs)"

.PP
Initialize credential handle attributes\&. Initializes the immutable Credential Handle Attributes The handle attributes are initialized as follows:
.PP
.IP "\(bu" 2
The search order is set to SERVICE, HOST, PROXY, USER
.IP "\(bu" 2
All other attributes are set to 0/NULL
.PP
.PP
\fBParameters\fP
.RS 4
\fIhandle_attrs\fP the attributes to be initialized 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS if initialization was successful, otherwise an error is returned 
.RE
.PP

.SS "globus_result_t globus_gsi_cred_handle_attrs_set_ca_cert_dir (\fBglobus_gsi_cred_handle_attrs_t\fP handle_attrs, const char * ca_cert_dir)"

.PP
Set the CA certificate directory\&. Set the Trusted CA Certificate Directory Location 
.PP
\fBParameters\fP
.RS 4
\fIhandle_attrs\fP the credential handle attributes to set 
.br
\fIca_cert_dir\fP the trusted ca certificates directory 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS if no errors occurred\&. In case of a null handle_attrs, an error object id is returned 
.RE
.PP

.SS "globus_result_t globus_gsi_cred_handle_attrs_set_search_order (\fBglobus_gsi_cred_handle_attrs_t\fP handle_attrs, \fBglobus_gsi_cred_type_t\fP search_order[])"

.PP
Set the search order\&. Set the search order for finding a user certificate\&. The default value is {SERVICE, HOST, PROXY, USER}
.PP
\fBParameters\fP
.RS 4
\fIhandle_attrs\fP The handle attributes to set the search order of 
.br
\fIsearch_order\fP The search order\&. Should be a three element array containing in some order PROXY, USER, HOST, SERVICE\&. The array should be terminated by the value GLOBUS_SO_END\&. 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_SUCCESS unless handle_attrs is null 
.RE
.PP

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