.TH "globus_net_manager_attr" 3 "Tue Jul 5 2022" "Version 1.7" "globus_net_manager" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_net_manager_attr \- Attributes
.PP
 \- Net Manager Attribute Management Functions\&.  

.SH SYNOPSIS
.br
.PP
.SS "Data Structures"

.in +1c
.ti -1c
.RI "struct \fBglobus_net_manager_attr_s\fP"
.br
.RI "Net Manager Attributes\&. "
.in -1c
.SS "Macros"

.in +1c
.ti -1c
.RI "#define \fBGLOBUS_NET_MANAGER_NULL_ATTR\fP"
.br
.RI "End of attribute array static initializer\&. "
.in -1c
.SS "Typedefs"

.in +1c
.ti -1c
.RI "typedef struct \fBglobus_net_manager_attr_s\fP \fBglobus_net_manager_attr_t\fP"
.br
.RI "Net Manager Attributes\&. "
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "globus_result_t \fBglobus_net_manager_attr_array_copy\fP (\fBglobus_net_manager_attr_t\fP **dest_array, const \fBglobus_net_manager_attr_t\fP *src_array)"
.br
.RI "Copy an array of Network Manager attributes\&. "
.ti -1c
.RI "void \fBglobus_net_manager_attr_array_delete\fP (\fBglobus_net_manager_attr_t\fP *attrs)"
.br
.RI "Destroy an array of Network Manager attributes\&. "
.ti -1c
.RI "globus_result_t \fBglobus_net_manager_attr_array_from_string\fP (\fBglobus_net_manager_attr_t\fP **attr, const char *scope, const char *attr_string)"
.br
.RI "Parse an array of Network Manager attributes from a string\&. "
.ti -1c
.RI "void \fBglobus_net_manager_attr_destroy\fP (\fBglobus_net_manager_attr_t\fP *attr)"
.br
.RI "Destroy the contents of an attribute\&. "
.ti -1c
.RI "globus_result_t \fBglobus_net_manager_attr_init\fP (\fBglobus_net_manager_attr_t\fP *attr, const char *scope, const char *name, const char *value)"
.br
.RI "Initialize the contents of an attribute\&. "
.in -1c
.SS "Variables"

.in +1c
.ti -1c
.RI "const \fBglobus_net_manager_attr_t\fP \fBglobus_net_manager_null_attr\fP = \fBGLOBUS_NET_MANAGER_NULL_ATTR\fP"
.br
.RI "End of array value\&. "
.in -1c
.SH "Detailed Description"
.PP 
Net Manager Attribute Management Functions\&. 


.SH "Typedef Documentation"
.PP 
.SS "typedef struct \fBglobus_net_manager_attr_s\fP \fBglobus_net_manager_attr_t\fP"

.PP
Net Manager Attributes\&. The globus_net_manager_attr_t structure defines a scoped (attribute, value) tuple\&. The scope in most cases is either the name of the transport driver or the 'globus_net_manager' scope, for attributes specific to the network manager implementation\&. 
.SH "Function Documentation"
.PP 
.SS "globus_result_t globus_net_manager_attr_array_copy (\fBglobus_net_manager_attr_t\fP ** dest_array, const \fBglobus_net_manager_attr_t\fP * src_array)"

.PP
Copy an array of Network Manager attributes\&. This function performs a deep copy of array of net_manager attributes\&. The new array will be stored in the pointer passed to by the dest_array parameter\&. It will contain all entries in the array passed as the src_array, ending with the value \fBGLOBUS_NET_MANAGER_NULL_ATTR\fP\&.
.PP
The caller must free the array stored in *dest_array by calling globus_net_manager_attr_array_destroy()\&.
.PP
\fBParameters\fP
.RS 4
\fIdest_array\fP A pointer to an array of attributes to be allocated and initialized\&. 
.br
\fIsrc_array\fP An array of attributes to copy\&.
.RE
.PP
\fBReturns\fP
.RS 4
On error, the dest_array is set to NULL and this function returns an error object\&. Otherwise, this function returns GLOBUS_SUCCESS\&. 
.RE
.PP

.SS "void globus_net_manager_attr_array_delete (\fBglobus_net_manager_attr_t\fP * attrs)"

.PP
Destroy an array of Network Manager attributes\&. This function deletes an array of Network Manager attributes and all values contained within them\&. The array must be terminated by the value \fBGLOBUS_NET_MANAGER_NULL_ATTR\fP\&.
.PP
\fBParameters\fP
.RS 4
\fIattrs\fP A pointer to an array of attributes to be freed\&. 
.RE
.PP

.SS "globus_result_t globus_net_manager_attr_array_from_string (\fBglobus_net_manager_attr_t\fP ** attr, const char * scope, const char * attr_string)"

.PP
Parse an array of Network Manager attributes from a string\&. This function parses a string containing a list of attributes and creates a new array of Network Manager attribute values from it\&. The array is terminated by globus_net_manager_null_attr\&.
.PP
Attribute strings are formed by the regular expression 
.PP
.nf
    NAME=VALUE(;NAME=VALUE)*

.fi
.PP
 The NAME and VALUE strings may contain any character except \fC;\fP \fC=\fP, and the carriage return and newline characters\&.
.PP
The caller must free the array stored in *attr by calling globus_net_manager_attr_array_destroy()\&.
.PP
\fBParameters\fP
.RS 4
\fIattr\fP A pointer to an array of attributes to be allocated and initialized\&. 
.br
\fIscope\fP The string to be added as the scope value of the attributes\&. 
.br
\fIattr_string\fP The string to be parsed\&.
.RE
.PP
\fBReturns\fP
.RS 4
On success, this function returns GLOBUS_SUCCESS\&. Otherwise, an error result is returned to the caller\&. 
.RE
.PP

.SS "void globus_net_manager_attr_destroy (\fBglobus_net_manager_attr_t\fP * attr)"

.PP
Destroy the contents of an attribute\&. This function frees the values contained in \fBattr\fP and reinitializes them to NULL\&. It \fIdoes not\fP free attr itself\&.
.PP
\fBParameters\fP
.RS 4
\fIattr\fP Pointer to the attribute to destroy\&. 
.RE
.PP

.SS "globus_result_t globus_net_manager_attr_init (\fBglobus_net_manager_attr_t\fP * attr, const char * scope, const char * name, const char * value)"

.PP
Initialize the contents of an attribute\&. This function initializes \fBattr\fP and with copies of the values passed as the \fBscope\fP, \fBname\fP, and \fBvalue\fP parameters\&.
.PP
\fBParameters\fP
.RS 4
\fIattr\fP Pointer to the attribute to initialize\&. 
.br
\fIscope\fP Attribute scope 
.br
\fIname\fP Attribute name 
.br
\fIvalue\fP Attribute value
.RE
.PP
\fBReturns\fP
.RS 4
On error, 'attr' is set to NULL and this function returns an error object\&. Otherwise this function returns 'GLOBUS_SUCCESS' 
.RE
.PP

.SH "Variable Documentation"
.PP 
.SS "const \fBglobus_net_manager_attr_t\fP globus_net_manager_null_attr = \fBGLOBUS_NET_MANAGER_NULL_ATTR\fP"

.PP
End of array value\&. This value may be assigned to an element in an array of Network Manager attributes to terminate the array\&. 
.SH "Author"
.PP 
Generated automatically by Doxygen for globus_net_manager from the source code\&.