libglobus-common-doc 14.10-2 / usr / share / doc / libglobus-common-dev / html / group__globus__url.html

This file is indexed.

/usr/share/doc/libglobus-common-dev/html/group__globus__url.html is in libglobus-common-doc 14.10-2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta name="robots" content="noindex">
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<!-- THIS FILE IS AUTOMATICALLY GENERATED FROM THE GLOBUS SOURCE CODE
     DO NOT MODIFY.
-->
<title>Globus Reference Manual</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head>
<body>
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__globus__url.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">URL String Parser</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structglobus__url__t.html">globus_url_t</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga774eeb8d0fd9e51f6be47aef44cf1aec"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__url.html#ga774eeb8d0fd9e51f6be47aef44cf1aec">globus_url_scheme_t</a> { <br/>
&#160;&#160;<a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aecaa0509be5c6d1b0c646c8299bebd3827a">GLOBUS_URL_SCHEME_FTP</a> =0, 
<br/>
&#160;&#160;<a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aeca5f429ade3fa679fcebd59b6ad776fa21">GLOBUS_URL_SCHEME_GSIFTP</a>, 
<br/>
&#160;&#160;<a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aeca8fff1250e66e914e0154968cd873ce75">GLOBUS_URL_SCHEME_HTTP</a>, 
<br/>
&#160;&#160;<a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aecaa3ac1014b9db9d8336ce382ec0d6fa6b">GLOBUS_URL_SCHEME_HTTPS</a>, 
<br/>
&#160;&#160;<a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aeca9a7c96b60f73b5208c416328b8c8acdf">GLOBUS_URL_SCHEME_LDAP</a>, 
<br/>
&#160;&#160;<a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aeca2669694de07c90b4c0542d126f0c7f63">GLOBUS_URL_SCHEME_FILE</a>, 
<br/>
&#160;&#160;<a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aeca6b22cb148821c396191f0fde690850d7">GLOBUS_URL_SCHEME_X_NEXUS</a>, 
<br/>
&#160;&#160;<a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aecad7fd6dfc894211eb8f2fdb4f79834118">GLOBUS_URL_SCHEME_X_GASS_CACHE</a>, 
<br/>
&#160;&#160;<a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aecad6735c1376f446768221acc12a4e4b92">GLOBUS_URL_SCHEME_UNKNOWN</a>
, <br/>
&#160;&#160;<a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aeca47660ee5ccc96f60106faa3358bc3008">GLOBUS_URL_NUM_SCHEMES</a>
<br/>
 }</td></tr>
<tr class="separator:ga774eeb8d0fd9e51f6be47aef44cf1aec"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga19ef174b33d9c8f0575715682bac8d65"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__url.html#ga19ef174b33d9c8f0575715682bac8d65">globus_url_parse</a> (const char *url_string, <a class="el" href="structglobus__url__t.html">globus_url_t</a> *url)</td></tr>
<tr class="separator:ga19ef174b33d9c8f0575715682bac8d65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabd9bb62fb3933b9b6a16ec4bf707a049"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__url.html#gabd9bb62fb3933b9b6a16ec4bf707a049">globus_url_parse_rfc1738</a> (const char *url_string, <a class="el" href="structglobus__url__t.html">globus_url_t</a> *url)</td></tr>
<tr class="separator:gabd9bb62fb3933b9b6a16ec4bf707a049"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0973f8aa338513fdcc78d259dfcc17a8"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__url.html#ga0973f8aa338513fdcc78d259dfcc17a8">globus_url_parse_loose</a> (const char *url_string, <a class="el" href="structglobus__url__t.html">globus_url_t</a> *url)</td></tr>
<tr class="separator:ga0973f8aa338513fdcc78d259dfcc17a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga95920d71729e6b114afefe824e58348a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__url.html#ga95920d71729e6b114afefe824e58348a">globus_url_destroy</a> (<a class="el" href="structglobus__url__t.html">globus_url_t</a> *url)</td></tr>
<tr class="separator:ga95920d71729e6b114afefe824e58348a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga11552fd218b39c198d45a0318cec4b86"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__url.html#ga11552fd218b39c198d45a0318cec4b86">globus_url_get_scheme</a> (const char *url_string, <a class="el" href="group__globus__url.html#ga774eeb8d0fd9e51f6be47aef44cf1aec">globus_url_scheme_t</a> *scheme_type)</td></tr>
<tr class="separator:ga11552fd218b39c198d45a0318cec4b86"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2d8c1bfed2091cdcd37425f06d76a8da"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__url.html#ga2d8c1bfed2091cdcd37425f06d76a8da">globus_url_copy</a> (<a class="el" href="structglobus__url__t.html">globus_url_t</a> *dst, const <a class="el" href="structglobus__url__t.html">globus_url_t</a> *src)</td></tr>
<tr class="separator:ga2d8c1bfed2091cdcd37425f06d76a8da"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>The Globus URL functions provide a simple mechanism for parsing a URL string into a data structure, and for determining the scheme of an URL string. </p>
<p>These functions are part of the Globus common library. The GLOBUS_COMMON module must be activated in order to use them. </p>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ga774eeb8d0fd9e51f6be47aef44cf1aec"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__globus__url.html#ga774eeb8d0fd9e51f6be47aef44cf1aec">globus_url_scheme_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>URL Schemes. </p>
<p>The Globus URL library supports a set of URL schemes (protocols). This enumeration can be used to quickly dispatch a parsed URL based on a constant value.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="structglobus__url__t.html#ae55d4a3c79a86a30e892a8f94da0623c" title="An enumerated scheme type. ">globus_url_t::scheme_type</a> </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga774eeb8d0fd9e51f6be47aef44cf1aecaa0509be5c6d1b0c646c8299bebd3827a"></a>GLOBUS_URL_SCHEME_FTP</em>&nbsp;</td><td class="fielddoc">
<p>File Transfer Protocol. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga774eeb8d0fd9e51f6be47aef44cf1aeca5f429ade3fa679fcebd59b6ad776fa21"></a>GLOBUS_URL_SCHEME_GSIFTP</em>&nbsp;</td><td class="fielddoc">
<p>GSI-enhanced File Transfer Protocol. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga774eeb8d0fd9e51f6be47aef44cf1aeca8fff1250e66e914e0154968cd873ce75"></a>GLOBUS_URL_SCHEME_HTTP</em>&nbsp;</td><td class="fielddoc">
<p>HyperText Transfer Protocol. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga774eeb8d0fd9e51f6be47aef44cf1aecaa3ac1014b9db9d8336ce382ec0d6fa6b"></a>GLOBUS_URL_SCHEME_HTTPS</em>&nbsp;</td><td class="fielddoc">
<p>Secure HyperText Transfer Protocol. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga774eeb8d0fd9e51f6be47aef44cf1aeca9a7c96b60f73b5208c416328b8c8acdf"></a>GLOBUS_URL_SCHEME_LDAP</em>&nbsp;</td><td class="fielddoc">
<p>Lightweight Directory Access Protocol. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga774eeb8d0fd9e51f6be47aef44cf1aeca2669694de07c90b4c0542d126f0c7f63"></a>GLOBUS_URL_SCHEME_FILE</em>&nbsp;</td><td class="fielddoc">
<p>File Location. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga774eeb8d0fd9e51f6be47aef44cf1aeca6b22cb148821c396191f0fde690850d7"></a>GLOBUS_URL_SCHEME_X_NEXUS</em>&nbsp;</td><td class="fielddoc">
<p>Nexus endpoint. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga774eeb8d0fd9e51f6be47aef44cf1aecad7fd6dfc894211eb8f2fdb4f79834118"></a>GLOBUS_URL_SCHEME_X_GASS_CACHE</em>&nbsp;</td><td class="fielddoc">
<p>GASS Cache Entry. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga774eeb8d0fd9e51f6be47aef44cf1aecad6735c1376f446768221acc12a4e4b92"></a>GLOBUS_URL_SCHEME_UNKNOWN</em>&nbsp;</td><td class="fielddoc">
<p>Any other URL of the form <b>scheme</b>://<b>something</b> </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga774eeb8d0fd9e51f6be47aef44cf1aeca47660ee5ccc96f60106faa3358bc3008"></a>GLOBUS_URL_NUM_SCHEMES</em>&nbsp;</td><td class="fielddoc">
<p>Total number of URL schemes supported. </p>
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga19ef174b33d9c8f0575715682bac8d65"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int globus_url_parse </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>url_string</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structglobus__url__t.html">globus_url_t</a> *&#160;</td>
          <td class="paramname"><em>url</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Parse a string containing a URL into a <a class="el" href="structglobus__url__t.html" title="Parsed URLs. ">globus_url_t</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">url_string</td><td>String to parse </td></tr>
    <tr><td class="paramname">url</td><td>Pointer to <a class="el" href="structglobus__url__t.html" title="Parsed URLs. ">globus_url_t</a> to be filled with the fields of the url</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">GLOBUS_SUCCESS</td><td>The string was successfully parsed. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_NULL_STRING</td><td>The url_string was GLOBUS_NULL. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_NULL_URL</td><td>The URL pointer was GLOBUS_NULL. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_BAD_SCHEME</td><td>The URL scheme (protocol) contained invalid characters. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_BAD_USER</td><td>The user part of the URL contained invalid characters. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_BAD_PASSWORD</td><td>The password part of the URL contained invalid characters. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_BAD_HOST</td><td>The host part of the URL contained invalid characters. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_BAD_PORT</td><td>The port part of the URL contained invalid characters. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_BAD_PATH</td><td>The path part of the URL contained invalid characters. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_BAD_DN</td><td>-9 The DN part of an LDAP URL contained invalid characters. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_BAD_ATTRIBUTES</td><td>-10 The attributes part of an LDAP URL contained invalid characters. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_BAD_SCOPE</td><td>-11 The scope part of an LDAP URL contained invalid characters. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_BAD_FILTER</td><td>-12 The filter part of an LDAP URL contained invalid characters. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_OUT_OF_MEMORY</td><td>-13 The library was unable to allocate memory to create the the <a class="el" href="structglobus__url__t.html" title="Parsed URLs. ">globus_url_t</a> contents. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_INTERNAL_ERROR</td><td>-14 Some unexpected error occurred parsing the URL. </td></tr>
  </table>
  </dd>
</dl>

<p>References <a class="el" href="structglobus__url__t.html#a17daeb126e4a903bc9c8e6a137d37265">globus_url_t::attributes</a>, <a class="el" href="structglobus__url__t.html#a44bfef2ffbac39a2c13afead20896634">globus_url_t::dn</a>, <a class="el" href="structglobus__url__t.html#ae6a66eb239f8e492b650a2996d9c3356">globus_url_t::filter</a>, <a class="el" href="group__globus__url.html#ga95920d71729e6b114afefe824e58348a">globus_url_destroy()</a>, <a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aeca2669694de07c90b4c0542d126f0c7f63">GLOBUS_URL_SCHEME_FILE</a>, <a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aecaa0509be5c6d1b0c646c8299bebd3827a">GLOBUS_URL_SCHEME_FTP</a>, <a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aeca5f429ade3fa679fcebd59b6ad776fa21">GLOBUS_URL_SCHEME_GSIFTP</a>, <a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aeca8fff1250e66e914e0154968cd873ce75">GLOBUS_URL_SCHEME_HTTP</a>, <a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aecaa3ac1014b9db9d8336ce382ec0d6fa6b">GLOBUS_URL_SCHEME_HTTPS</a>, <a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aeca9a7c96b60f73b5208c416328b8c8acdf">GLOBUS_URL_SCHEME_LDAP</a>, <a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aecad7fd6dfc894211eb8f2fdb4f79834118">GLOBUS_URL_SCHEME_X_GASS_CACHE</a>, <a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aeca6b22cb148821c396191f0fde690850d7">GLOBUS_URL_SCHEME_X_NEXUS</a>, <a class="el" href="structglobus__url__t.html#a426f95d68e567f85085bb46f793efcbe">globus_url_t::host</a>, <a class="el" href="structglobus__url__t.html#a86cb729a9e34a4ff4bb845911caa4c4f">globus_url_t::password</a>, <a class="el" href="structglobus__url__t.html#a1002c75ce212166a6e54a0715cbd33c2">globus_url_t::port</a>, <a class="el" href="structglobus__url__t.html#ac21843402017d0a6bf169b6a750ab532">globus_url_t::scheme</a>, <a class="el" href="structglobus__url__t.html#ae55d4a3c79a86a30e892a8f94da0623c">globus_url_t::scheme_type</a>, <a class="el" href="structglobus__url__t.html#a9f56bc7e168c9ba8b74c5c823d67f27b">globus_url_t::scope</a>, <a class="el" href="structglobus__url__t.html#a110e29cafeaabb1fdeba0b1f17ed211a">globus_url_t::url_path</a>, <a class="el" href="structglobus__url__t.html#a184c8c55bcaea5f9f10226b59f07800a">globus_url_t::url_specific_part</a>, and <a class="el" href="structglobus__url__t.html#a7820dc87cbed173a8e81df403d35920a">globus_url_t::user</a>.</p>

</div>
</div>
<a class="anchor" id="gabd9bb62fb3933b9b6a16ec4bf707a049"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int globus_url_parse_rfc1738 </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>url_string</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structglobus__url__t.html">globus_url_t</a> *&#160;</td>
          <td class="paramname"><em>url</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Parse a string containing a URL into a <a class="el" href="structglobus__url__t.html" title="Parsed URLs. ">globus_url_t</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">url_string</td><td>String to parse </td></tr>
    <tr><td class="paramname">url</td><td>Pointer to <a class="el" href="structglobus__url__t.html" title="Parsed URLs. ">globus_url_t</a> to be filled with the fields of the url</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">GLOBUS_SUCCESS</td><td>The string was successfully parsed. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_NULL_STRING</td><td>The url_string was GLOBUS_NULL. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_NULL_URL</td><td>The URL pointer was GLOBUS_NULL. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_BAD_SCHEME</td><td>The URL scheme (protocol) contained invalid characters. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_BAD_USER</td><td>The user part of the URL contained invalid characters. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_BAD_PASSWORD</td><td>The password part of the URL contained invalid characters. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_BAD_HOST</td><td>The host part of the URL contained invalid characters. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_BAD_PORT</td><td>The port part of the URL contained invalid characters. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_BAD_PATH</td><td>The path part of the URL contained invalid characters. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_BAD_DN</td><td>-9 The DN part of an LDAP URL contained invalid characters. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_BAD_ATTRIBUTES</td><td>-10 The attributes part of an LDAP URL contained invalid characters. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_BAD_SCOPE</td><td>-11 The scope part of an LDAP URL contained invalid characters. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_BAD_FILTER</td><td>-12 The filter part of an LDAP URL contained invalid characters. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_OUT_OF_MEMORY</td><td>-13 The library was unable to allocate memory to create the the <a class="el" href="structglobus__url__t.html" title="Parsed URLs. ">globus_url_t</a> contents. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_INTERNAL_ERROR</td><td>-14 Some unexpected error occurred parsing the URL. </td></tr>
  </table>
  </dd>
</dl>

<p>References <a class="el" href="structglobus__url__t.html#a17daeb126e4a903bc9c8e6a137d37265">globus_url_t::attributes</a>, <a class="el" href="structglobus__url__t.html#a44bfef2ffbac39a2c13afead20896634">globus_url_t::dn</a>, <a class="el" href="structglobus__url__t.html#ae6a66eb239f8e492b650a2996d9c3356">globus_url_t::filter</a>, <a class="el" href="group__globus__url.html#ga95920d71729e6b114afefe824e58348a">globus_url_destroy()</a>, <a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aeca2669694de07c90b4c0542d126f0c7f63">GLOBUS_URL_SCHEME_FILE</a>, <a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aecaa0509be5c6d1b0c646c8299bebd3827a">GLOBUS_URL_SCHEME_FTP</a>, <a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aeca5f429ade3fa679fcebd59b6ad776fa21">GLOBUS_URL_SCHEME_GSIFTP</a>, <a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aeca8fff1250e66e914e0154968cd873ce75">GLOBUS_URL_SCHEME_HTTP</a>, <a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aecaa3ac1014b9db9d8336ce382ec0d6fa6b">GLOBUS_URL_SCHEME_HTTPS</a>, <a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aeca9a7c96b60f73b5208c416328b8c8acdf">GLOBUS_URL_SCHEME_LDAP</a>, <a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aecad7fd6dfc894211eb8f2fdb4f79834118">GLOBUS_URL_SCHEME_X_GASS_CACHE</a>, <a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aeca6b22cb148821c396191f0fde690850d7">GLOBUS_URL_SCHEME_X_NEXUS</a>, <a class="el" href="structglobus__url__t.html#a426f95d68e567f85085bb46f793efcbe">globus_url_t::host</a>, <a class="el" href="structglobus__url__t.html#a86cb729a9e34a4ff4bb845911caa4c4f">globus_url_t::password</a>, <a class="el" href="structglobus__url__t.html#a1002c75ce212166a6e54a0715cbd33c2">globus_url_t::port</a>, <a class="el" href="structglobus__url__t.html#ac21843402017d0a6bf169b6a750ab532">globus_url_t::scheme</a>, <a class="el" href="structglobus__url__t.html#ae55d4a3c79a86a30e892a8f94da0623c">globus_url_t::scheme_type</a>, <a class="el" href="structglobus__url__t.html#a9f56bc7e168c9ba8b74c5c823d67f27b">globus_url_t::scope</a>, <a class="el" href="structglobus__url__t.html#a110e29cafeaabb1fdeba0b1f17ed211a">globus_url_t::url_path</a>, <a class="el" href="structglobus__url__t.html#a184c8c55bcaea5f9f10226b59f07800a">globus_url_t::url_specific_part</a>, and <a class="el" href="structglobus__url__t.html#a7820dc87cbed173a8e81df403d35920a">globus_url_t::user</a>.</p>

</div>
</div>
<a class="anchor" id="ga0973f8aa338513fdcc78d259dfcc17a8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int globus_url_parse_loose </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>url_string</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structglobus__url__t.html">globus_url_t</a> *&#160;</td>
          <td class="paramname"><em>url</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Parse a string containing a URL into a <a class="el" href="structglobus__url__t.html" title="Parsed URLs. ">globus_url_t</a> Looser restrictions on characters allowed in the path part of the URL. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">url_string</td><td>String to parse </td></tr>
    <tr><td class="paramname">url</td><td>Pointer to <a class="el" href="structglobus__url__t.html" title="Parsed URLs. ">globus_url_t</a> to be filled with the fields of the url</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">GLOBUS_SUCCESS</td><td>The string was successfully parsed. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_NULL_STRING</td><td>The url_string was GLOBUS_NULL. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_NULL_URL</td><td>The URL pointer was GLOBUS_NULL. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_BAD_SCHEME</td><td>The URL scheme (protocol) contained invalid characters. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_BAD_USER</td><td>The user part of the URL contained invalid characters. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_BAD_PASSWORD</td><td>The password part of the URL contained invalid characters. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_BAD_HOST</td><td>The host part of the URL contained invalid characters. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_BAD_PORT</td><td>The port part of the URL contained invalid characters. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_BAD_PATH</td><td>The path part of the URL contained invalid characters. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_BAD_DN</td><td>-9 The DN part of an LDAP URL contained invalid characters. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_BAD_ATTRIBUTES</td><td>-10 The attributes part of an LDAP URL contained invalid characters. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_BAD_SCOPE</td><td>-11 The scope part of an LDAP URL contained invalid characters. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_BAD_FILTER</td><td>-12 The filter part of an LDAP URL contained invalid characters. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_OUT_OF_MEMORY</td><td>-13 The library was unable to allocate memory to create the the <a class="el" href="structglobus__url__t.html" title="Parsed URLs. ">globus_url_t</a> contents. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_INTERNAL_ERROR</td><td>-14 Some unexpected error occurred parsing the URL. </td></tr>
  </table>
  </dd>
</dl>

<p>References <a class="el" href="structglobus__url__t.html#a17daeb126e4a903bc9c8e6a137d37265">globus_url_t::attributes</a>, <a class="el" href="structglobus__url__t.html#a44bfef2ffbac39a2c13afead20896634">globus_url_t::dn</a>, <a class="el" href="structglobus__url__t.html#ae6a66eb239f8e492b650a2996d9c3356">globus_url_t::filter</a>, <a class="el" href="group__globus__url.html#ga95920d71729e6b114afefe824e58348a">globus_url_destroy()</a>, <a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aeca2669694de07c90b4c0542d126f0c7f63">GLOBUS_URL_SCHEME_FILE</a>, <a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aecaa0509be5c6d1b0c646c8299bebd3827a">GLOBUS_URL_SCHEME_FTP</a>, <a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aeca5f429ade3fa679fcebd59b6ad776fa21">GLOBUS_URL_SCHEME_GSIFTP</a>, <a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aeca8fff1250e66e914e0154968cd873ce75">GLOBUS_URL_SCHEME_HTTP</a>, <a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aecaa3ac1014b9db9d8336ce382ec0d6fa6b">GLOBUS_URL_SCHEME_HTTPS</a>, <a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aeca9a7c96b60f73b5208c416328b8c8acdf">GLOBUS_URL_SCHEME_LDAP</a>, <a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aecad7fd6dfc894211eb8f2fdb4f79834118">GLOBUS_URL_SCHEME_X_GASS_CACHE</a>, <a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aeca6b22cb148821c396191f0fde690850d7">GLOBUS_URL_SCHEME_X_NEXUS</a>, <a class="el" href="structglobus__url__t.html#a426f95d68e567f85085bb46f793efcbe">globus_url_t::host</a>, <a class="el" href="structglobus__url__t.html#a86cb729a9e34a4ff4bb845911caa4c4f">globus_url_t::password</a>, <a class="el" href="structglobus__url__t.html#a1002c75ce212166a6e54a0715cbd33c2">globus_url_t::port</a>, <a class="el" href="structglobus__url__t.html#ac21843402017d0a6bf169b6a750ab532">globus_url_t::scheme</a>, <a class="el" href="structglobus__url__t.html#ae55d4a3c79a86a30e892a8f94da0623c">globus_url_t::scheme_type</a>, <a class="el" href="structglobus__url__t.html#a9f56bc7e168c9ba8b74c5c823d67f27b">globus_url_t::scope</a>, <a class="el" href="structglobus__url__t.html#a110e29cafeaabb1fdeba0b1f17ed211a">globus_url_t::url_path</a>, <a class="el" href="structglobus__url__t.html#a184c8c55bcaea5f9f10226b59f07800a">globus_url_t::url_specific_part</a>, and <a class="el" href="structglobus__url__t.html#a7820dc87cbed173a8e81df403d35920a">globus_url_t::user</a>.</p>

</div>
</div>
<a class="anchor" id="ga95920d71729e6b114afefe824e58348a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int globus_url_destroy </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structglobus__url__t.html">globus_url_t</a> *&#160;</td>
          <td class="paramname"><em>url</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Destroy a <a class="el" href="structglobus__url__t.html" title="Parsed URLs. ">globus_url_t</a> structure. </p>
<p>This function frees all memory associated with a <a class="el" href="structglobus__url__t.html" title="Parsed URLs. ">globus_url_t</a> structure.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">url</td><td>The url structure to destroy</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">GLOBUS_SUCCESS</td><td>The URL was successfully destroyed. </td></tr>
  </table>
  </dd>
</dl>

<p>References <a class="el" href="structglobus__url__t.html#a17daeb126e4a903bc9c8e6a137d37265">globus_url_t::attributes</a>, <a class="el" href="structglobus__url__t.html#a44bfef2ffbac39a2c13afead20896634">globus_url_t::dn</a>, <a class="el" href="structglobus__url__t.html#ae6a66eb239f8e492b650a2996d9c3356">globus_url_t::filter</a>, <a class="el" href="structglobus__url__t.html#a426f95d68e567f85085bb46f793efcbe">globus_url_t::host</a>, <a class="el" href="structglobus__url__t.html#a86cb729a9e34a4ff4bb845911caa4c4f">globus_url_t::password</a>, <a class="el" href="structglobus__url__t.html#ac21843402017d0a6bf169b6a750ab532">globus_url_t::scheme</a>, <a class="el" href="structglobus__url__t.html#a9f56bc7e168c9ba8b74c5c823d67f27b">globus_url_t::scope</a>, <a class="el" href="structglobus__url__t.html#a110e29cafeaabb1fdeba0b1f17ed211a">globus_url_t::url_path</a>, <a class="el" href="structglobus__url__t.html#a184c8c55bcaea5f9f10226b59f07800a">globus_url_t::url_specific_part</a>, and <a class="el" href="structglobus__url__t.html#a7820dc87cbed173a8e81df403d35920a">globus_url_t::user</a>.</p>

</div>
</div>
<a class="anchor" id="ga11552fd218b39c198d45a0318cec4b86"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int globus_url_get_scheme </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>url_string</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__globus__url.html#ga774eeb8d0fd9e51f6be47aef44cf1aec">globus_url_scheme_t</a> *&#160;</td>
          <td class="paramname"><em>scheme_type</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the scheme of an URL. </p>
<p>This function determines the scheme type of the url string, and populates the variable pointed to by second parameter with that value. This performs a less expensive parsing than <a class="el" href="group__globus__url.html#ga19ef174b33d9c8f0575715682bac8d65" title="Parse a string containing a URL into a globus_url_t. ">globus_url_parse()</a> and is suitable for applications which need only to choose a handler based on the URL scheme.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">url_string</td><td>The string containing the URL. </td></tr>
    <tr><td class="paramname">scheme_type</td><td>A pointer to a globus_url_scheme_t which will be set to the scheme.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">GLOBUS_SUCCESS</td><td>The URL scheme was recogized, and scheme_type has been updated. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_BAD_SCHEME</td><td>The URL scheme was not recogized. </td></tr>
  </table>
  </dd>
</dl>

<p>References <a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aeca2669694de07c90b4c0542d126f0c7f63">GLOBUS_URL_SCHEME_FILE</a>, <a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aecaa0509be5c6d1b0c646c8299bebd3827a">GLOBUS_URL_SCHEME_FTP</a>, <a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aeca5f429ade3fa679fcebd59b6ad776fa21">GLOBUS_URL_SCHEME_GSIFTP</a>, <a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aeca8fff1250e66e914e0154968cd873ce75">GLOBUS_URL_SCHEME_HTTP</a>, <a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aecaa3ac1014b9db9d8336ce382ec0d6fa6b">GLOBUS_URL_SCHEME_HTTPS</a>, <a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aeca9a7c96b60f73b5208c416328b8c8acdf">GLOBUS_URL_SCHEME_LDAP</a>, <a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aecad6735c1376f446768221acc12a4e4b92">GLOBUS_URL_SCHEME_UNKNOWN</a>, <a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aecad7fd6dfc894211eb8f2fdb4f79834118">GLOBUS_URL_SCHEME_X_GASS_CACHE</a>, and <a class="el" href="group__globus__url.html#gga774eeb8d0fd9e51f6be47aef44cf1aeca6b22cb148821c396191f0fde690850d7">GLOBUS_URL_SCHEME_X_NEXUS</a>.</p>

</div>
</div>
<a class="anchor" id="ga2d8c1bfed2091cdcd37425f06d76a8da"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int globus_url_copy </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structglobus__url__t.html">globus_url_t</a> *&#160;</td>
          <td class="paramname"><em>dst</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structglobus__url__t.html">globus_url_t</a> *&#160;</td>
          <td class="paramname"><em>src</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Create a copy of an URL structure. </p>
<p>This function copies the contents of a url structure into another.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">dst</td><td>The URL structure to be populated with a copy of the contents of src. </td></tr>
    <tr><td class="paramname">src</td><td>The original URL.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">GLOBUS_SUCCESS</td><td>The URL was successfully copied. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_NULL_URL</td><td>One of the URLs was GLOBUS_NULL. </td></tr>
    <tr><td class="paramname">GLOBUS_URL_ERROR_OUT_OF_MEMORY;</td><td>The library was unable to allocate memory to create the the <a class="el" href="structglobus__url__t.html" title="Parsed URLs. ">globus_url_t</a> contents. </td></tr>
  </table>
  </dd>
</dl>

<p>References <a class="el" href="structglobus__url__t.html#a1002c75ce212166a6e54a0715cbd33c2">globus_url_t::port</a>, <a class="el" href="structglobus__url__t.html#ac21843402017d0a6bf169b6a750ab532">globus_url_t::scheme</a>, and <a class="el" href="structglobus__url__t.html#ae55d4a3c79a86a30e892a8f94da0623c">globus_url_t::scheme_type</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<hr>
<p align="center">
<a href="http://www.globus.org/toolkit/about.html" target="_top">about globus</a> |
<a href="http://www.globus.org/toolkit/" target="_top">globus toolkit</a> |
<a href="https://dev.globus.org/wiki/Welcome/" target="_top">dev.globus</a>
<br>
<br>
Comments? <a href="mailto:webmaster@globus.org">webmaster@globus.org</a>
</body>
</html>

APT Browse - Built by Thomas Orozco.