← Back to branch summary

~ubuntu-branches/ubuntu/trusty/globus-gram-client/trusty-proposed

« back to all changes in this revision

Viewing changes to globus_gram_client_attr.c

  • Committer: Bazaar Package Importer
  • Author(s): Mattias Ellert
  • Date: 2011-06-06 16:40:48 UTC
  • Revision ID: james.westby@ubuntu.com-20110606164048-4ihreraeyrcy6a0r
Tags: 10.4-3
* Fix doxygen markup
* Use system jquery script

Show diffs side-by-side

added added

removed removed

Lines of Context:
globus_gram_client_attr.c
33
33
 * @ingroup globus_gram_client_attr
34
34
 *
35
35
 * @details
36
 
 * The @a globus_gram_client_attr_init() function creates a new opaque
 
36
 * The globus_gram_client_attr_init() function creates a new opaque
37
37
 * structure that can be used to specify custom attributes for performing
38
38
 * GRAM client operations.
39
39
 * 
42
42
 *     attribute.
43
43
 *
44
44
 * @return
45
 
 *     Upon success, @a globus_gram_client_attr_init() modifies the @a attr
 
45
 *     Upon success, globus_gram_client_attr_init() modifies the @a attr
46
46
 *     parameter to point to a new GRAM client attribute and returns
47
 
 *     @a GLOBUS_SUCCESS. If an error occurs, @a globus_gram_client_attr_init()
 
47
 *     @a GLOBUS_SUCCESS. If an error occurs, globus_gram_client_attr_init()
48
48
 *     returns an integer error code and value of @a attr is undefined.
49
49
 *
50
50
 * @retval GLOBUS_SUCCESS
84
84
 * @ingroup globus_gram_client_attr
85
85
 *
86
86
 * @details
87
 
 * The @a globus_gram_client_attr_destroy() function destroys and frees
 
87
 * The globus_gram_client_attr_destroy() function destroys and frees
88
88
 * a GRAM client attribute. After this function returns, the value pointed
89
89
 * to by @a attr is no longer valid and must not be used.
90
90
 *
93
93
 *     the attribute will be freed and it will be an invalid attribute.
94
94
 *
95
95
 * @return
96
 
 *     Upon success, @a globus_gram_client_attr_destroy() destroys the 
 
96
 *     Upon success, globus_gram_client_attr_destroy() destroys the 
97
97
 *     attribute pointed to by the @a attr parameter and sets it to an invalid
98
 
 *     state.  If an error occurs, @a globus_gram_client_attr_destroy()
 
98
 *     state.  If an error occurs, globus_gram_client_attr_destroy()
99
99
 *     returns an integer error code and value of @a attr is unchanged.
100
100
 *
101
101
 * @retval GLOBUS_SUCCESS
138
138
 * @ingroup globus_gram_client_attr
139
139
 * 
140
140
 * @details
141
 
 * The @a globus_gram_client_attr_set_credential() function sets the 
 
141
 * The globus_gram_client_attr_set_credential() function sets the 
142
142
 * value of the @b credential in an attribute to the GSSAPI credential
143
143
 * named by the @a credential parameter. This is done as a shallow copy, so 
144
144
 * the value of @a credential must not be freed until the attribute will
153
153
 *     to use the default security credential.
154
154
 *
155
155
 * @return
156
 
 *     Upon success, @a globus_gram_client_attr_set_credential() modifies the
 
156
 *     Upon success, globus_gram_client_attr_set_credential() modifies the
157
157
 *     the attribute pointed to by the @a attr parameter to use the credential
158
158
 *     specified by the @a credential parameter and returns @a GLOBUS_SUCCESS.
159
 
 *     If an error occurs, @a globus_gram_client_attr_set_credential()
 
159
 *     If an error occurs, globus_gram_client_attr_set_credential()
160
160
 *     returns an integer error code and the attribute named by @a attr is
161
161
 *     unchanged.
162
162
 * 
190
190
 * @ingroup globus_gram_client_attr
191
191
 *
192
192
 * @details
193
 
 * The @a globus_gram_client_attr_get_credential() function gets the 
 
193
 * The globus_gram_client_attr_get_credential() function gets the 
194
194
 * value of the @b credential in an attribute and modifies the @a credential
195
195
 * parameter to point to it. This is a shallow copy.
196
196
 *
201
201
 *     credential which the @a attr is currently using.
202
202
 *
203
203
 * @return
204
 
 *     Upon success, @a globus_gram_client_attr_get_credential() modifies the
 
204
 *     Upon success, globus_gram_client_attr_get_credential() modifies the
205
205
 *     the value pointed to by the @a credential parameter to be the same
206
206
 *     credential as that being used by the attribute named by the @a attr
207
207
 *     parameter and returns @a GLOBUS_SUCCESS.
208
 
 *     If an error occurs, @a globus_gram_client_attr_get_credential()
 
208
 *     If an error occurs, globus_gram_client_attr_get_credential()
209
209
 *     returns an integer error code and the value pointed to by the
210
210
 *     @a credential parameter is undefined.
211
211
 *
251
251
 * @ingroup globus_gram_client_attr
252
252
 *
253
253
 * @details
254
 
 * The @a globus_gram_client_attr_set_delegation_mode() function sets the 
 
254
 * The globus_gram_client_attr_set_delegation_mode() function sets the 
255
255
 * value of the @b delegation_mode in an attribute to the delegation mode
256
256
 * in the @a mode parameter.
257
257
 *
266
266
 *     The new value of the delegation mode.
267
267
 *
268
268
 * @return
269
 
 *     Upon success, @a globus_gram_client_attr_set_delegation_mode() modifies
 
269
 *     Upon success, globus_gram_client_attr_set_delegation_mode() modifies
270
270
 *     the the attribute named by the @a attr parameter to use the delegation
271
271
 *     mode in the @a mode parameter and returns GLOBUS_SUCCESS.
272
 
 *     If an error occurs, @a globus_gram_client_attr_set_delegation_mode()
 
272
 *     If an error occurs, globus_gram_client_attr_set_delegation_mode()
273
273
 *     returns an integer error code and the @a delegation_mode attribute 
274
274
 *     value is unchanged.
275
275
 * 
310
310
 * @ingroup globus_gram_client_attr
311
311
 * 
312
312
 * @details
313
 
 * The @a globus_gram_client_attr_get_delegation_mode() function gets the 
 
313
 * The globus_gram_client_attr_get_delegation_mode() function gets the 
314
314
 * value of the @b delegation_mode in an attribute and modifies the
315
315
 * @a mode parameter to point to its value.
316
316
 *
321
321
 *     which the @a attr is currently using.
322
322
 *
323
323
 * @return
324
 
 *     Upon success, @a globus_gram_client_attr_get_delegation_mode() modifies
 
324
 *     Upon success, globus_gram_client_attr_get_delegation_mode() modifies
325
325
 *     the the value pointed to by the @a mode parameter as described above
326
326
 *     and returns @a GLOBUS_SUCCESS.
327
 
 *     If an error occurs, @a globus_gram_client_attr_get_delegation_mode()
 
327
 *     If an error occurs, globus_gram_client_attr_get_delegation_mode()
328
328
 *     returns an integer error code and the value pointed to by the
329
329
 *     @a mode parameter is undefined.
330
330
 *