.TH "globus_rsl_param" 3 "Fri Sep 2 2016" "Version 10.11" "globus_rsl" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_rsl_param \- RSL Value Accessors
.SS "Functions"

.in +1c
.ti -1c
.RI "int \fBglobus_rsl_value_concatenation_set_left\fP (globus_rsl_value_t *concatenation_node, globus_rsl_value_t *new_left_node)"
.br
.RI "\fISet the left-hand value of a concatenation\&. \fP"
.ti -1c
.RI "int \fBglobus_rsl_value_concatenation_set_right\fP (globus_rsl_value_t *concatenation_node, globus_rsl_value_t *new_right_node)"
.br
.RI "\fISet the right-hand value of a concatenation\&. \fP"
.ti -1c
.RI "int \fBglobus_rsl_value_list_param_get\fP (globus_list_t *ast_node_list, int required_type, char ***value, int *value_ctr)"
.br
.RI "\fIGet the values of an RSL value list\&. \fP"
.ti -1c
.RI "globus_list_t * \fBglobus_rsl_param_get_values\fP (globus_rsl_t *ast_node, char *param)"
.br
.RI "\fIGet the list of values for an RSL attribute\&. \fP"
.ti -1c
.RI "int \fBglobus_rsl_param_get\fP (globus_rsl_t *ast_node, int param_type, char *param, char ***values)"
.br
.RI "\fIGet the value strings for an RSL attribute\&. \fP"
.in -1c
.SH "Detailed Description"
.PP 

.SH "Function Documentation"
.PP 
.SS "int globus_rsl_param_get (globus_rsl_t * ast_node, int param_type, char * param, char *** values)"

.PP
Get the value strings for an RSL attribute\&. The \fBglobus_rsl_param_get()\fP function searches the RSL parse tree pointed to by the \fIast_node\fP parameter and returns an array of pointers to the strings bound to the attribute named by the \fIparam\fP parameter\&.
.PP
\fBParameters:\fP
.RS 4
\fIast_node\fP A pointer to an RSL syntax tree that will be searched\&. This may be a relation or boolean RSL string\&. 
.br
\fIparam_type\fP A flag indicating what type of values are expected for the RSL attribute named by the \fIparam\fP parameter\&. This flag value may be \fIGLOBUS_RSL_PARAM_SINGLE_LITERAL\fP, \fIGLOBUS_RSL_PARAM_MULTI_LITERAL\fP, or \fIGLOBUS_RSL_PARAM_SEQUENCE\fP\&. 
.br
\fIparam\fP A string pointing to the name of of the RSL attribute to search for\&. 
.br
\fIvalues\fP An output parameter pointing to an array of strings that will be allocated and contain pointers to the RSL value strings if they match the format specified by the \fIparam_type\fP flag\&. The caller is responsible for freeing this array, but not the strings in the array\&.
.RE
.PP
\fBReturns:\fP
.RS 4
Upon success, the \fBglobus_rsl_param_get()\fP function returns \fIGLOBUS_SUCCESS\fP and modifies the \fIvalues\fP parameter as described above\&. If an error occurs, \fBglobus_rsl_param_get()\fP returns a non-zero value\&. 
.RE
.PP

.SS "globus_list_t* globus_rsl_param_get_values (globus_rsl_t * ast_node, char * param)"

.PP
Get the list of values for an RSL attribute\&. The \fBglobus_rsl_param_get_values()\fP function searches the RSL parse tree pointed to by the \fIast_node\fP parameter and returns the value list that is bound to the attribute named by the \fIparam\fP parameter\&.
.PP
\fBParameters:\fP
.RS 4
\fIast_node\fP A pointer to an RSL syntax tree that will be searched\&. This may be a relation or boolean RSL string\&. 
.br
\fIparam\fP The name of the attribute to search for in the parse tree pointed to by the \fIast_node\fP parameter\&.
.RE
.PP
\fBReturns:\fP
.RS 4
Upon success, the \fBglobus_rsl_param_get_values()\fP function returns a pointer to the list of values associated with the attribute named by \fIparam\fP in the RSL parse tree pointed to by \fIast_node\fP\&. If an error occurs, \fBglobus_rsl_param_get_values()\fP returns NULL\&. 
.RE
.PP

.SS "int globus_rsl_value_concatenation_set_left (globus_rsl_value_t * concatenation_node, globus_rsl_value_t * new_left_node)"

.PP
Set the left-hand value of a concatenation\&. The \fBglobus_rsl_value_concatenation_set_left()\fP sets the left hand side of a concatenation pointed to by \fIconcatenation_node\fP to the value pointed to by \fInew_left_node\fP\&. If there was any previous value to the left hand side of the concatenation, it is discarded but not freed\&.
.PP
\fBParameters:\fP
.RS 4
\fIconcatenation_node\fP A pointer to the RSL value concatenation node to modify\&. 
.br
\fInew_left_node\fP A pointer to the new left hand side of the concatenation\&.
.RE
.PP
\fBReturns:\fP
.RS 4
Upon success, \fBglobus_rsl_value_concatenation_set_left()\fP returns \fIGLOBUS_SUCCESS\fP and modifies the value pointed to by the \fIconcatenation_node\fP parameter to use the value pointed to by the \fInew_left_node\fP parameter as its left hand side value\&. If an error occurs, \fBglobus_rsl_value_concatenation_set_left()\fP returns -1\&. 
.RE
.PP

.SS "int globus_rsl_value_concatenation_set_right (globus_rsl_value_t * concatenation_node, globus_rsl_value_t * new_right_node)"

.PP
Set the right-hand value of a concatenation\&. The \fBglobus_rsl_value_concatenation_set_right()\fP sets the right-hand side of a concatenation pointed to by \fIconcatenation_node\fP to the value pointed to by \fInew_right_node\fP\&. If there was any previous value to the right-hand side of the concatenation, it is discarded but not freed\&.
.PP
\fBParameters:\fP
.RS 4
\fIconcatenation_node\fP A pointer to the RSL value concatenation node to modify\&. 
.br
\fInew_right_node\fP A pointer to the new right hand side of the concatenation\&.
.RE
.PP
\fBReturns:\fP
.RS 4
Upon success, \fBglobus_rsl_value_concatenation_set_right()\fP returns \fIGLOBUS_SUCCESS\fP and modifies the value pointed to by the \fIconcatenation_node\fP parameter to use the value pointed to by the \fInew_right_node\fP parameter as its right hand side value\&. If an error occurs, \fBglobus_rsl_value_concatenation_set_right()\fP returns -1\&. 
.RE
.PP

.SS "int globus_rsl_value_list_param_get (globus_list_t * ast_node_list, int required_type, char *** value, int * value_ctr)"

.PP
Get the values of an RSL value list\&. The \fBglobus_rsl_value_list_param_get()\fP function copies pointers to literal string values or string pairs associated with the list of globus_rsl_value_t pointers pointed to by the \fIast_node_list\fP parameter to the output array pointed to by the \fIvalue\fP parameter\&. It modifies the value pointed to by the \fIvalue_ctr\fP parameter to be the number of strings copied into the array\&.
.PP
\fBParameters:\fP
.RS 4
\fIast_node_list\fP A pointer to a list of globus_rsl_value_t pointers whose values will be copied to the \fIvalue\fP parameter array\&. 
.br
\fIrequired_type\fP A flag indicating whether the list is expected to contain literal strings or string pairs\&. This value may be one of \fIGLOBUS_RSL_VALUE_LITERAL\fP or \fIGLOBUS_RSL_VALUE_SEQUENCE\fP\&. 
.br
\fIvalue\fP An output parameter pointing to an array of strings\&. This array must be at least as large as the number of elements in the list pointed to by \fIast_node_list\fP\&. 
.br
\fIvalue_ctr\fP An output parameter pointing to an integer that will be incremented for each string copied into the \fIvalue\fP array\&.
.RE
.PP
\fBReturns:\fP
.RS 4
Upon success, the \fBglobus_rsl_value_list_param_get()\fP function returns GLOBUS_SUCCESS and modifies the values pointed to by the \fIvalue\fP and \fIvalue_ctr\fP prameters as described above\&. If an error occurs, \fBglobus_rsl_value_list_param_get()\fP returns a non-zero value\&. 
.RE
.PP

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