<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3.1"/>
<title>xrootd: XrdCl::File Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">xrootd
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceXrdCl.html">XrdCl</a></li><li class="navelem"><a class="el" href="classXrdCl_1_1File.html">File</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pri-attribs">Private Attributes</a> |
<a href="classXrdCl_1_1File-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">XrdCl::File Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A file.
<a href="classXrdCl_1_1File.html#details">More...</a></p>
<p><code>#include <<a class="el" href="XrdClFile_8hh_source.html">XrdClFile.hh</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ab1fd10f20928d3fcce74f3654e42a2b4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1File.html#ab1fd10f20928d3fcce74f3654e42a2b4">File</a> ()</td></tr>
<tr class="memdesc:ab1fd10f20928d3fcce74f3654e42a2b4"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#ab1fd10f20928d3fcce74f3654e42a2b4">More...</a><br/></td></tr>
<tr class="separator:ab1fd10f20928d3fcce74f3654e42a2b4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a04771f3ee7950d47b67b4e26589c7f20"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1File.html#a04771f3ee7950d47b67b4e26589c7f20">~File</a> ()</td></tr>
<tr class="memdesc:a04771f3ee7950d47b67b4e26589c7f20"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a04771f3ee7950d47b67b4e26589c7f20">More...</a><br/></td></tr>
<tr class="separator:a04771f3ee7950d47b67b4e26589c7f20"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a78a8d315dcd100286f93c55941234a74"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXrdCl_1_1XRootDStatus.html">XRootDStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1File.html#a78a8d315dcd100286f93c55941234a74">Open</a> (const std::string &url, <a class="el" href="structXrdCl_1_1OpenFlags.html#afbdc445a8ca583879d56d0cbb45383f9">OpenFlags::Flags</a> flags, <a class="el" href="structXrdCl_1_1Access.html#ae3783784c483cb37dca8ee3c1023053d">Access::Mode</a> mode, <a class="el" href="classXrdCl_1_1ResponseHandler.html">ResponseHandler</a> *handler, uint16_t timeout=0)</td></tr>
<tr class="separator:a78a8d315dcd100286f93c55941234a74"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a855b7fbcea5dfa135690eb21349f9f68"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXrdCl_1_1XRootDStatus.html">XRootDStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1File.html#a855b7fbcea5dfa135690eb21349f9f68">Open</a> (const std::string &url, <a class="el" href="structXrdCl_1_1OpenFlags.html#afbdc445a8ca583879d56d0cbb45383f9">OpenFlags::Flags</a> flags, <a class="el" href="structXrdCl_1_1Access.html#ae3783784c483cb37dca8ee3c1023053d">Access::Mode</a> mode=<a class="el" href="structXrdCl_1_1Access.html#ae3783784c483cb37dca8ee3c1023053da80f7cf99ff17ec9bf5633f30df3f4d08">Access::None</a>, uint16_t timeout=0)</td></tr>
<tr class="separator:a855b7fbcea5dfa135690eb21349f9f68"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a09b08b19bd8366dd74022c71f1a8b73e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXrdCl_1_1XRootDStatus.html">XRootDStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1File.html#a09b08b19bd8366dd74022c71f1a8b73e">Close</a> (<a class="el" href="classXrdCl_1_1ResponseHandler.html">ResponseHandler</a> *handler, uint16_t timeout=0)</td></tr>
<tr class="separator:a09b08b19bd8366dd74022c71f1a8b73e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7a014d659e6fccfaf5fe2e58f2986239"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXrdCl_1_1XRootDStatus.html">XRootDStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1File.html#a7a014d659e6fccfaf5fe2e58f2986239">Close</a> (uint16_t timeout=0)</td></tr>
<tr class="separator:a7a014d659e6fccfaf5fe2e58f2986239"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6748e8324e3320cc3f6ef25ba7742cba"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXrdCl_1_1XRootDStatus.html">XRootDStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1File.html#a6748e8324e3320cc3f6ef25ba7742cba">Stat</a> (bool force, <a class="el" href="classXrdCl_1_1ResponseHandler.html">ResponseHandler</a> *handler, uint16_t timeout=0)</td></tr>
<tr class="separator:a6748e8324e3320cc3f6ef25ba7742cba"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9a38b0e850aa7f775dc72cd6e72ab096"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXrdCl_1_1XRootDStatus.html">XRootDStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1File.html#a9a38b0e850aa7f775dc72cd6e72ab096">Stat</a> (bool force, <a class="el" href="classXrdCl_1_1StatInfo.html">StatInfo</a> *&response, uint16_t timeout=0)</td></tr>
<tr class="separator:a9a38b0e850aa7f775dc72cd6e72ab096"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2e625ddd8b1fd26268acbde047b62b83"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXrdCl_1_1XRootDStatus.html">XRootDStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1File.html#a2e625ddd8b1fd26268acbde047b62b83">Read</a> (uint64_t offset, uint32_t size, void *buffer, <a class="el" href="classXrdCl_1_1ResponseHandler.html">ResponseHandler</a> *handler, uint16_t timeout=0)</td></tr>
<tr class="separator:a2e625ddd8b1fd26268acbde047b62b83"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6a5e7374869dea48130a2041122f6ec8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXrdCl_1_1XRootDStatus.html">XRootDStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1File.html#a6a5e7374869dea48130a2041122f6ec8">Read</a> (uint64_t offset, uint32_t size, void *buffer, uint32_t &bytesRead, uint16_t timeout=0)</td></tr>
<tr class="separator:a6a5e7374869dea48130a2041122f6ec8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad5171c945a560c820d9705dd5d522668"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXrdCl_1_1XRootDStatus.html">XRootDStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1File.html#ad5171c945a560c820d9705dd5d522668">Write</a> (uint64_t offset, uint32_t size, const void *buffer, <a class="el" href="classXrdCl_1_1ResponseHandler.html">ResponseHandler</a> *handler, uint16_t timeout=0)</td></tr>
<tr class="separator:ad5171c945a560c820d9705dd5d522668"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8e32fe0ad9245b6ac09740374a624402"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXrdCl_1_1XRootDStatus.html">XRootDStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1File.html#a8e32fe0ad9245b6ac09740374a624402">Write</a> (uint64_t offset, uint32_t size, const void *buffer, uint16_t timeout=0)</td></tr>
<tr class="separator:a8e32fe0ad9245b6ac09740374a624402"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5f47d5e46cfc39d18c46d61100f04c17"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXrdCl_1_1XRootDStatus.html">XRootDStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1File.html#a5f47d5e46cfc39d18c46d61100f04c17">Sync</a> (<a class="el" href="classXrdCl_1_1ResponseHandler.html">ResponseHandler</a> *handler, uint16_t timeout=0)</td></tr>
<tr class="separator:a5f47d5e46cfc39d18c46d61100f04c17"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6339aae931a2ab194ff6c039c7c88c59"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXrdCl_1_1XRootDStatus.html">XRootDStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1File.html#a6339aae931a2ab194ff6c039c7c88c59">Sync</a> (uint16_t timeout=0)</td></tr>
<tr class="separator:a6339aae931a2ab194ff6c039c7c88c59"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af7b3c49d2fa450f89c45c9cc2a480faa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXrdCl_1_1XRootDStatus.html">XRootDStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1File.html#af7b3c49d2fa450f89c45c9cc2a480faa">Truncate</a> (uint64_t size, <a class="el" href="classXrdCl_1_1ResponseHandler.html">ResponseHandler</a> *handler, uint16_t timeout=0)</td></tr>
<tr class="separator:af7b3c49d2fa450f89c45c9cc2a480faa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:accccf845c092124e2aa0ab116f71cac5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXrdCl_1_1XRootDStatus.html">XRootDStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1File.html#accccf845c092124e2aa0ab116f71cac5">Truncate</a> (uint64_t size, uint16_t timeout=0)</td></tr>
<tr class="separator:accccf845c092124e2aa0ab116f71cac5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa53adb05186be04430a0504909c47692"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXrdCl_1_1XRootDStatus.html">XRootDStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1File.html#aa53adb05186be04430a0504909c47692">VectorRead</a> (const <a class="el" href="namespaceXrdCl.html#aa52ca1653049f3be3f263d1caab18942">ChunkList</a> &chunks, void *buffer, <a class="el" href="classXrdCl_1_1ResponseHandler.html">ResponseHandler</a> *handler, uint16_t timeout=0)</td></tr>
<tr class="separator:aa53adb05186be04430a0504909c47692"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a286aeb203ddf3ee6c18738d87c4f2c2d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXrdCl_1_1XRootDStatus.html">XRootDStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1File.html#a286aeb203ddf3ee6c18738d87c4f2c2d">VectorRead</a> (const <a class="el" href="namespaceXrdCl.html#aa52ca1653049f3be3f263d1caab18942">ChunkList</a> &chunks, void *buffer, <a class="el" href="classXrdCl_1_1VectorReadInfo.html">VectorReadInfo</a> *&vReadInfo, uint16_t timeout=0)</td></tr>
<tr class="separator:a286aeb203ddf3ee6c18738d87c4f2c2d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6897dcffa7341ba82741f0530a9aab61"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1File.html#a6897dcffa7341ba82741f0530a9aab61">IsOpen</a> () const </td></tr>
<tr class="memdesc:a6897dcffa7341ba82741f0530a9aab61"><td class="mdescLeft"> </td><td class="mdescRight">Check if the file is open. <a href="#a6897dcffa7341ba82741f0530a9aab61">More...</a><br/></td></tr>
<tr class="separator:a6897dcffa7341ba82741f0530a9aab61"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae715545bb110aa5065694b2568695e48"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1File.html#ae715545bb110aa5065694b2568695e48">EnableReadRecovery</a> (bool enable=true)</td></tr>
<tr class="separator:ae715545bb110aa5065694b2568695e48"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0a2c4d2b00d443d7113e31bd0dad71d9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1File.html#a0a2c4d2b00d443d7113e31bd0dad71d9">EnableWriteRecovery</a> (bool enable=true)</td></tr>
<tr class="separator:a0a2c4d2b00d443d7113e31bd0dad71d9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aecb3c8d2b65c8559f146664900f994c6"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1File.html#aecb3c8d2b65c8559f146664900f994c6">GetDataServer</a> () const </td></tr>
<tr class="memdesc:aecb3c8d2b65c8559f146664900f994c6"><td class="mdescLeft"> </td><td class="mdescRight">Get the data server the file is accessed at. <a href="#aecb3c8d2b65c8559f146664900f994c6">More...</a><br/></td></tr>
<tr class="separator:aecb3c8d2b65c8559f146664900f994c6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af3b782be5439dd49ee96a20f152591f1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXrdCl_1_1URL.html">URL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1File.html#af3b782be5439dd49ee96a20f152591f1">GetLastURL</a> () const </td></tr>
<tr class="memdesc:af3b782be5439dd49ee96a20f152591f1"><td class="mdescLeft"> </td><td class="mdescRight">Get final url with all the cgi information. <a href="#af3b782be5439dd49ee96a20f152591f1">More...</a><br/></td></tr>
<tr class="separator:af3b782be5439dd49ee96a20f152591f1"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:aa5b5a135ea89f36faa501cd44f41584c"><td class="memItemLeft" align="right" valign="top">FileStateHandler * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1File.html#aa5b5a135ea89f36faa501cd44f41584c">pStateHandler</a></td></tr>
<tr class="separator:aa5b5a135ea89f36faa501cd44f41584c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A file. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="ab1fd10f20928d3fcce74f3654e42a2b4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XrdCl::File::File </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
</div>
</div>
<a class="anchor" id="a04771f3ee7950d47b67b4e26589c7f20"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual XrdCl::File::~File </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a09b08b19bd8366dd74022c71f1a8b73e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXrdCl_1_1XRootDStatus.html">XRootDStatus</a> XrdCl::File::Close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXrdCl_1_1ResponseHandler.html">ResponseHandler</a> * </td>
<td class="paramname"><em>handler</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>timeout</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Close the file - async</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handler</td><td>handler to be notified about the status of the operation </td></tr>
<tr><td class="paramname">timeout</td><td>timeout value, if 0 the environment default will be used </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>status of the operation </dd></dl>
</div>
</div>
<a class="anchor" id="a7a014d659e6fccfaf5fe2e58f2986239"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXrdCl_1_1XRootDStatus.html">XRootDStatus</a> XrdCl::File::Close </td>
<td>(</td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>timeout</em> = <code>0</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Close the file - sync</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">timeout</td><td>timeout value, if 0 the environment default will be used </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>status of the operation </dd></dl>
</div>
</div>
<a class="anchor" id="ae715545bb110aa5065694b2568695e48"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XrdCl::File::EnableReadRecovery </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>enable</em> = <code>true</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enable/disable state recovery procedures while the file is open for reading </p>
</div>
</div>
<a class="anchor" id="a0a2c4d2b00d443d7113e31bd0dad71d9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XrdCl::File::EnableWriteRecovery </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>enable</em> = <code>true</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enable/disable state recovery procedures while the file is open for writing or read/write </p>
</div>
</div>
<a class="anchor" id="aecb3c8d2b65c8559f146664900f994c6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string XrdCl::File::GetDataServer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the data server the file is accessed at. </p>
</div>
</div>
<a class="anchor" id="af3b782be5439dd49ee96a20f152591f1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXrdCl_1_1URL.html">URL</a> XrdCl::File::GetLastURL </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get final url with all the cgi information. </p>
</div>
</div>
<a class="anchor" id="a6897dcffa7341ba82741f0530a9aab61"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool XrdCl::File::IsOpen </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if the file is open. </p>
</div>
</div>
<a class="anchor" id="a78a8d315dcd100286f93c55941234a74"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXrdCl_1_1XRootDStatus.html">XRootDStatus</a> XrdCl::File::Open </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>url</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structXrdCl_1_1OpenFlags.html#afbdc445a8ca583879d56d0cbb45383f9">OpenFlags::Flags</a> </td>
<td class="paramname"><em>flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structXrdCl_1_1Access.html#ae3783784c483cb37dca8ee3c1023053d">Access::Mode</a> </td>
<td class="paramname"><em>mode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXrdCl_1_1ResponseHandler.html">ResponseHandler</a> * </td>
<td class="paramname"><em>handler</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>timeout</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Open the file pointed to by the given <a class="el" href="classXrdCl_1_1URL.html" title="URL representation.">URL</a> - async</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">url</td><td>url of the file to be opened </td></tr>
<tr><td class="paramname">flags</td><td><a class="el" href="structXrdCl_1_1OpenFlags.html#afbdc445a8ca583879d56d0cbb45383f9" title="Open flags, may be or'd when appropriate.">OpenFlags::Flags</a> </td></tr>
<tr><td class="paramname">mode</td><td><a class="el" href="structXrdCl_1_1Access.html#ae3783784c483cb37dca8ee3c1023053d" title="Access mode.">Access::Mode</a> for new files, 0 otherwise </td></tr>
<tr><td class="paramname">handler</td><td>handler to be notified about the status of the operation </td></tr>
<tr><td class="paramname">timeout</td><td>timeout value, if 0 the environment default will be used </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>status of the operation </dd></dl>
</div>
</div>
<a class="anchor" id="a855b7fbcea5dfa135690eb21349f9f68"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXrdCl_1_1XRootDStatus.html">XRootDStatus</a> XrdCl::File::Open </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>url</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structXrdCl_1_1OpenFlags.html#afbdc445a8ca583879d56d0cbb45383f9">OpenFlags::Flags</a> </td>
<td class="paramname"><em>flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structXrdCl_1_1Access.html#ae3783784c483cb37dca8ee3c1023053d">Access::Mode</a> </td>
<td class="paramname"><em>mode</em> = <code><a class="el" href="structXrdCl_1_1Access.html#ae3783784c483cb37dca8ee3c1023053da80f7cf99ff17ec9bf5633f30df3f4d08">Access::None</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>timeout</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Open the file pointed to by the given <a class="el" href="classXrdCl_1_1URL.html" title="URL representation.">URL</a> - sync</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">url</td><td>url of the file to be opened </td></tr>
<tr><td class="paramname">flags</td><td><a class="el" href="structXrdCl_1_1OpenFlags.html#afbdc445a8ca583879d56d0cbb45383f9" title="Open flags, may be or'd when appropriate.">OpenFlags::Flags</a> </td></tr>
<tr><td class="paramname">mode</td><td><a class="el" href="structXrdCl_1_1Access.html#ae3783784c483cb37dca8ee3c1023053d" title="Access mode.">Access::Mode</a> for new files, 0 otherwise </td></tr>
<tr><td class="paramname">timeout</td><td>timeout value, if 0 the environment default will be used </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>status of the operation </dd></dl>
</div>
</div>
<a class="anchor" id="a2e625ddd8b1fd26268acbde047b62b83"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXrdCl_1_1XRootDStatus.html">XRootDStatus</a> XrdCl::File::Read </td>
<td>(</td>
<td class="paramtype">uint64_t </td>
<td class="paramname"><em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXrdCl_1_1ResponseHandler.html">ResponseHandler</a> * </td>
<td class="paramname"><em>handler</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>timeout</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read a data chunk at a given offset - async</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">offset</td><td>offset from the beginning of the file </td></tr>
<tr><td class="paramname">size</td><td>number of bytes to be read </td></tr>
<tr><td class="paramname">buffer</td><td>a pointer to a buffer big enough to hold the data or 0 if the buffer should be allocated by the system </td></tr>
<tr><td class="paramname">handler</td><td>handler to be notified when the response arrives, the response parameter will hold a <a class="el" href="structXrdCl_1_1ChunkInfo.html" title="Describe a data chunk for vector read.">ChunkInfo</a> object if the procedure was successful </td></tr>
<tr><td class="paramname">timeout</td><td>timeout value, if 0 the environment default will be used </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>status of the operation </dd></dl>
</div>
</div>
<a class="anchor" id="a6a5e7374869dea48130a2041122f6ec8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXrdCl_1_1XRootDStatus.html">XRootDStatus</a> XrdCl::File::Read </td>
<td>(</td>
<td class="paramtype">uint64_t </td>
<td class="paramname"><em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t & </td>
<td class="paramname"><em>bytesRead</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>timeout</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read a data chunk at a given offset - sync</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">offset</td><td>offset from the beginning of the file </td></tr>
<tr><td class="paramname">size</td><td>number of bytes to be read </td></tr>
<tr><td class="paramname">buffer</td><td>a pointer to a buffer big enough to hold the data </td></tr>
<tr><td class="paramname">bytesRead</td><td>number of bytes actually read </td></tr>
<tr><td class="paramname">timeout</td><td>timeout value, if 0 the environment default will be used </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>status of the operation </dd></dl>
</div>
</div>
<a class="anchor" id="a6748e8324e3320cc3f6ef25ba7742cba"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXrdCl_1_1XRootDStatus.html">XRootDStatus</a> XrdCl::File::Stat </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>force</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXrdCl_1_1ResponseHandler.html">ResponseHandler</a> * </td>
<td class="paramname"><em>handler</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>timeout</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Obtain status information for this file - async</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">force</td><td>do not use the cached information, force re-stating </td></tr>
<tr><td class="paramname">handler</td><td>handler to be notified when the response arrives, the response parameter will hold a <a class="el" href="classXrdCl_1_1StatInfo.html" title="Object stat info.">StatInfo</a> object if the procedure is successful </td></tr>
<tr><td class="paramname">timeout</td><td>timeout value, if 0 the environment default will be used </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>status of the operation </dd></dl>
</div>
</div>
<a class="anchor" id="a9a38b0e850aa7f775dc72cd6e72ab096"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXrdCl_1_1XRootDStatus.html">XRootDStatus</a> XrdCl::File::Stat </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>force</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXrdCl_1_1StatInfo.html">StatInfo</a> *& </td>
<td class="paramname"><em>response</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>timeout</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Obtain status information for this file - sync</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">force</td><td>do not use the cached information, force re-stating </td></tr>
<tr><td class="paramname">response</td><td>the response (to be deleted by the user) </td></tr>
<tr><td class="paramname">timeout</td><td>timeout value, if 0 the environment default will be used </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>status of the operation </dd></dl>
</div>
</div>
<a class="anchor" id="a5f47d5e46cfc39d18c46d61100f04c17"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXrdCl_1_1XRootDStatus.html">XRootDStatus</a> XrdCl::File::Sync </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXrdCl_1_1ResponseHandler.html">ResponseHandler</a> * </td>
<td class="paramname"><em>handler</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>timeout</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Commit all pending disk writes - async</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handler</td><td>handler to be notified when the response arrives </td></tr>
<tr><td class="paramname">timeout</td><td>timeout value, if 0 the environment default will be used </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>status of the operation </dd></dl>
</div>
</div>
<a class="anchor" id="a6339aae931a2ab194ff6c039c7c88c59"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXrdCl_1_1XRootDStatus.html">XRootDStatus</a> XrdCl::File::Sync </td>
<td>(</td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>timeout</em> = <code>0</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Commit all pending disk writes - sync</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">timeout</td><td>timeout value, if 0 the environment default will be used </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>status of the operation </dd></dl>
</div>
</div>
<a class="anchor" id="af7b3c49d2fa450f89c45c9cc2a480faa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXrdCl_1_1XRootDStatus.html">XRootDStatus</a> XrdCl::File::Truncate </td>
<td>(</td>
<td class="paramtype">uint64_t </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXrdCl_1_1ResponseHandler.html">ResponseHandler</a> * </td>
<td class="paramname"><em>handler</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>timeout</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Truncate the file to a particular size - async</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>desired size of the file </td></tr>
<tr><td class="paramname">handler</td><td>handler to be notified when the response arrives </td></tr>
<tr><td class="paramname">timeout</td><td>timeout value, if 0 the environment default will be used </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>status of the operation </dd></dl>
</div>
</div>
<a class="anchor" id="accccf845c092124e2aa0ab116f71cac5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXrdCl_1_1XRootDStatus.html">XRootDStatus</a> XrdCl::File::Truncate </td>
<td>(</td>
<td class="paramtype">uint64_t </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>timeout</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Truncate the file to a particular size - sync</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>desired size of the file </td></tr>
<tr><td class="paramname">timeout</td><td>timeout value, if 0 the environment default will be used </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>status of the operation </dd></dl>
</div>
</div>
<a class="anchor" id="aa53adb05186be04430a0504909c47692"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXrdCl_1_1XRootDStatus.html">XRootDStatus</a> XrdCl::File::VectorRead </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespaceXrdCl.html#aa52ca1653049f3be3f263d1caab18942">ChunkList</a> & </td>
<td class="paramname"><em>chunks</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXrdCl_1_1ResponseHandler.html">ResponseHandler</a> * </td>
<td class="paramname"><em>handler</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>timeout</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read scattered data chunks in one operation - async</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">chunks</td><td>list of the chunks to be read and buffers to put the data in. The default maximum chunk size is 2097136 bytes and the default maximum number of chunks per request is 1024. The server may be queried using <a class="el" href="classXrdCl_1_1FileSystem.html#a9aa19b1faa6b3cc08f5dbc09953ddd42">FileSystem::Query</a> for the actual settings. </td></tr>
<tr><td class="paramname">buffer</td><td>if zero the buffer pointers in the chunk list will be used, otherwise it needs to point to a buffer big enough to hold the requested data </td></tr>
<tr><td class="paramname">handler</td><td>handler to be notified when the response arrives </td></tr>
<tr><td class="paramname">timeout</td><td>timeout value, if 0 then the environment default will be used </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>status of the operation </dd></dl>
</div>
</div>
<a class="anchor" id="a286aeb203ddf3ee6c18738d87c4f2c2d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXrdCl_1_1XRootDStatus.html">XRootDStatus</a> XrdCl::File::VectorRead </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespaceXrdCl.html#aa52ca1653049f3be3f263d1caab18942">ChunkList</a> & </td>
<td class="paramname"><em>chunks</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXrdCl_1_1VectorReadInfo.html">VectorReadInfo</a> *& </td>
<td class="paramname"><em>vReadInfo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>timeout</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read scattered data chunks in one operation - sync</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">chunks</td><td>list of the chunks to be read and buffers to put the data in. The default maximum chunk size is 2097136 bytes and the default maximum number of chunks per request is 1024. The server may be queried using <a class="el" href="classXrdCl_1_1FileSystem.html#a9aa19b1faa6b3cc08f5dbc09953ddd42">FileSystem::Query</a> for the actual settings. </td></tr>
<tr><td class="paramname">buffer</td><td>if zero the buffer pointers in the chunk list will be used, otherwise it needs to point to a buffer big enough to hold the requested data </td></tr>
<tr><td class="paramname">vReadInfo</td><td>buffer size and chunk information </td></tr>
<tr><td class="paramname">timeout</td><td>timeout value, if 0 then the environment default will be used </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>status of the operation </dd></dl>
</div>
</div>
<a class="anchor" id="ad5171c945a560c820d9705dd5d522668"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXrdCl_1_1XRootDStatus.html">XRootDStatus</a> XrdCl::File::Write </td>
<td>(</td>
<td class="paramtype">uint64_t </td>
<td class="paramname"><em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXrdCl_1_1ResponseHandler.html">ResponseHandler</a> * </td>
<td class="paramname"><em>handler</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>timeout</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write a data chunk at a given offset - async The call interprets and returns the server response, which may be either a success or a failure, it does not contain the number of bytes that were actually written.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">offset</td><td>offset from the beginning of the file </td></tr>
<tr><td class="paramname">size</td><td>number of bytes to be written </td></tr>
<tr><td class="paramname">buffer</td><td>a pointer to the buffer holding the data to be written </td></tr>
<tr><td class="paramname">handler</td><td>handler to be notified when the response arrives </td></tr>
<tr><td class="paramname">timeout</td><td>timeout value, if 0 the environment default will be used </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>status of the operation </dd></dl>
</div>
</div>
<a class="anchor" id="a8e32fe0ad9245b6ac09740374a624402"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXrdCl_1_1XRootDStatus.html">XRootDStatus</a> XrdCl::File::Write </td>
<td>(</td>
<td class="paramtype">uint64_t </td>
<td class="paramname"><em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>timeout</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write a data chunk at a given offset - sync The call interprets and returns the server response, which may be either a success or a failure, it does not contain the number of bytes that were actually written.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">offset</td><td>offset from the beginning of the file </td></tr>
<tr><td class="paramname">size</td><td>number of bytes to be written </td></tr>
<tr><td class="paramname">buffer</td><td>a pointer to the buffer holding the data to be written </td></tr>
<tr><td class="paramname">timeout</td><td>timeout value, if 0 the environment default will be used </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>status of the operation </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="aa5b5a135ea89f36faa501cd44f41584c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">FileStateHandler* XrdCl::File::pStateHandler</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XrdClFile_8hh_source.html">XrdClFile.hh</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>
distrib
>
Fedora
>
18
>
x86_64
>
media
>
updates
>
by-pkgid
>
749e483016bbc41594aeb77eb13e3491
>
files
>
598
