libglobus-rls-client-doc 5.2-8 / usr / share / doc / libglobus-rls-client-dev / html / group__globus__rls__client__queryresult.html

This file is indexed.

/usr/share/doc/libglobus-rls-client-dev/html/group__globus__rls__client__queryresult.html is in libglobus-rls-client-doc 5.2-8.

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
<!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.7.6.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</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>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('group__globus__rls__client__queryresult.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Query Results</div>  </div>
</div><!--header-->
<div class="contents">
<h2><a name="nested-classes"></a>
Data Structures</h2>
<ul>
<li>struct <a class="el" href="structglobus__rls__attribute__object__t.html">globus_rls_attribute_object_t</a>
<dl class="el"><dd class="mdescRight"><a class="el" href="group__globus__rls__client__lrc__operation.html#ga87ada8ca2fe9004277849478665109d4" title="Search for objects (LFNs or PFNs) in a LRC database that have the specified attribute whose value mat...">globus_rls_client_lrc_attr_search()</a> returns a list of these structures which include the object name (LFN or PFN) and attribute value found by the query.  <a href="structglobus__rls__attribute__object__t.html#details">More...</a><br/></dl><li>struct <a class="el" href="structglobus__rls__string2__t.html">globus_rls_string2_t</a>
<dl class="el"><dd class="mdescRight">String pair result.  <a href="structglobus__rls__string2__t.html#details">More...</a><br/></dl><li>struct <a class="el" href="structglobus__rls__string2__bulk__t.html">globus_rls_string2_bulk_t</a>
<dl class="el"><dd class="mdescRight">String pair result with return code, returned by bulk query operations.  <a href="structglobus__rls__string2__bulk__t.html#details">More...</a><br/></dl></ul>
<h2><a name="func-members"></a>
Functions</h2>
<ul>
<li>globus_result_t <a class="el" href="group__globus__rls__client__queryresult.html#ga90012568e1489e562ad2bf660409adc8">globus_rls_client_free_list</a> (globus_list_t *list)
</ul>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>List results are returned as globus_list_t's, list datums depend on the type of query (eg <a class="el" href="structglobus__rls__string2__t.html" title="String pair result.">globus_rls_string2_t</a>, <a class="el" href="structglobus__rls__attribute__t.html" title="Object (LFN or PFN) attribute type.">globus_rls_attribute_t</a>, etc). </p>
<p>A list result should be freed with <a class="el" href="group__globus__rls__client__queryresult.html#ga90012568e1489e562ad2bf660409adc8" title="Free result list returned by one of the query functions.">globus_rls_client_free_list()</a> when it's no longer needed. RLS supports limiting the number of results returned by a single query using an offset and reslimit. The offset specifies which result to begin with, reslimit specifies how many results to return. Offset should begin at 0 to retrieve all records. If reslimit is 0 then all results are returned at once, unless the server has a limit on results configured. If NULL is passed as the offset argument then the API will repeatedly call the query function until are results are retrieved. The following are equivalent examples of how to print the lfn,pfn pairs returned by <a class="el" href="group__globus__rls__client__lrc__operation.html#gad3ba17decd9541134405ecf3a693c9e2" title="Return LFNs mapped to PFN in the LRC database.">globus_rls_client_lrc_get_lfn()</a>:</p>
<div class="fragment"><pre class="fragment">
   globus_list_t *str2_list;
   globus_list_t *p;
   globus_rls_string2_t *str2;

   // Retrieve all results, API will handle looping through partial results
   // if the server has a limit configured.  Error handling has been omitted.
   globus_rls_client_lrc_get_lfn(h, "somepfn", NULL, 0, &amp;str2_list);
   for (p = str2_list; p; p = globus_list_rest(p)) {
     str2 = (globus_rls_string2_t *) globus_list_first(p);
     printf("lfn: %s pfn:%s\n", str2-&gt;s1, str2-&gt;s2);
   }
   globus_rls_client_free_list(str2_list);

   // This code fragment retrieves results 5 at a time.  Note offset is set
   // to -1 when the server has no more results to return.
   int offset = 0;

   while (globus_rls_client_lrc_get_lfn(h, "somepfn", &amp;offset, 5, &amp;str2_list) == GLOBUS_SUCCESS) {
     for (p = str2_list; p; p = globus_list_rest(p)) {
       str2 = (globus_rls_string2_t *) globus_list_first(p);
       printf("lfn: %s pfn:%s\n", str2-&gt;s1, str2-&gt;s2);
     }
     globus_rls_client_free_list(str2_list);
     if (offset == -1)
       break;
   }
   </pre></div> <hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga90012568e1489e562ad2bf660409adc8"></a><!-- doxytag: member="globus_rls_client.h::globus_rls_client_free_list" ref="ga90012568e1489e562ad2bf660409adc8" args="(globus_list_t *list)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">globus_result_t <a class="el" href="group__globus__rls__client__queryresult.html#ga90012568e1489e562ad2bf660409adc8">globus_rls_client_free_list</a> </td>
          <td>(</td>
          <td class="paramtype">globus_list_t *&#160;</td>
          <td class="paramname"><em>list</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Free result list returned by one of the query functions. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">list</td><td>List returned by one of the query functions.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt><b>Return values:</b></dt><dd>
  <table class="retval">
    <tr><td class="paramname">GLOBUS_SUCCESS</td><td>List and contents successfully freed. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
</div>
  <div id="nav-path" class="navpath">
    <ul>
<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.