blob: a43ae4fd948a2193955d83cde82c896a07c77ef6 [file] [log] [blame]
{{+bindTo:partials.standard_nacl_api}}
<h1>pp::URLRequestInfo Class Reference</h1>
<div id="doxygen-ref">
{{- dummy div to appease doxygen -}}
<div>
<!-- Generated by Doxygen 1.7.6.1 -->
</div>
<!--header-->
<div class="contents">
<!-- doxytag: class="pp::URLRequestInfo" --><!-- doxytag: inherits="pp::Resource" --><div class="dynheader">
Inheritance diagram for pp::URLRequestInfo:</div>
<div class="dyncontent">
<div class="center"><img src="classpp_1_1_u_r_l_request_info__inherit__graph.png" border="0" usemap="#pp_1_1_u_r_l_request_info_inherit__map" alt="Inheritance graph" /></div>
<map name="pp_1_1_u_r_l_request_info_inherit__map" id="pp_1_1_u_r_l_request_info_inherit__map">
<area shape="rect" id="node2" href="classpp_1_1_resource.html" title="A reference counted module resource." alt="" coords="25,5,129,32"></area></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classpp_1_1_u_r_l_request_info-members.html">List of all members.</a></p>
<h2>
Public Member Functions</h2><table class="memberdecls">
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_request_info.html#afd2068e004d90104cdc8472756d6131d">URLRequestInfo</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_request_info.html#a95ae0d638a82bcd18318ae6340735321">URLRequestInfo</a> (const <a class="el" href="classpp_1_1_instance_handle.html">InstanceHandle</a> &amp;instance)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_request_info.html#a6f52f41f98fa5917addd412417b7d5d4">URLRequestInfo</a> (const <a class="el" href="classpp_1_1_u_r_l_request_info.html">URLRequestInfo</a> &amp;other)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_request_info.html#a679c2c4a7247e0b0985595c24e61cf9c">SetProperty</a> (PP_URLRequestProperty property, const <a class="el" href="classpp_1_1_var.html">Var</a> &amp;value)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_request_info.html#ab16f2efba1f2ddc434e2fc860dcbe900">AppendDataToBody</a> (const void *data, uint32_t len)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_request_info.html#af19afd7e5849e68497f1e4f4b7400995">AppendFileToBody</a> (const <a class="el" href="classpp_1_1_file_ref.html">FileRef</a> &amp;file_ref, PP_Time expected_last_modified_time=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_request_info.html#a1ae72c8ac65a6cd6c174c8df238038fd">AppendFileRangeToBody</a> (const <a class="el" href="classpp_1_1_file_ref.html">FileRef</a> &amp;file_ref, int64_t start_offset, int64_t length, PP_Time expected_last_modified_time=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_request_info.html#a97cdeb02a63922704d47c585a4e2baaf">SetURL</a> (const <a class="el" href="classpp_1_1_var.html">Var</a> &amp;url_string)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_request_info.html#abf4024d196a5139dbca2e95b9ab9bdb6">SetMethod</a> (const <a class="el" href="classpp_1_1_var.html">Var</a> &amp;method_string)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_request_info.html#a7105409f66e2eb5595eec0e0ae07c4f6">SetHeaders</a> (const <a class="el" href="classpp_1_1_var.html">Var</a> &amp;headers_string)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_request_info.html#a7bd36cb47bc0bc3579292f81581359b8">SetStreamToFile</a> (bool enable)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_request_info.html#a72dd5d3b335a429af0ffa266e338a110">SetFollowRedirects</a> (bool enable)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_request_info.html#aca69393ce31673c1cc5407d15774e310">SetRecordDownloadProgress</a> (bool enable)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_request_info.html#a52cfef994077173627a809bdf891e01a">SetRecordUploadProgress</a> (bool enable)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_request_info.html#af6232dbb546c37c5438fadbada30353a">SetCustomReferrerURL</a> (const <a class="el" href="classpp_1_1_var.html">Var</a> &amp;url)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_request_info.html#a39a5000e734a378d412fbe87e38dabe4">SetAllowCrossOriginRequests</a> (bool enable)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_request_info.html#afa23501e503ee1787c4663d74f00d0c4">SetAllowCredentials</a> (bool enable)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_request_info.html#af25b7f4b3aa00af49140921d28fa09c9">SetCustomContentTransferEncoding</a> (const <a class="el" href="classpp_1_1_var.html">Var</a> &amp;content_transfer_encoding)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_request_info.html#aa2c6bb4f07e5372bd4b0ed49f9b67990">SetPrefetchBufferUpperThreshold</a> (int32_t size)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_request_info.html#a498fc64ad75ed2d44e33f2fdb3c0cad3">SetPrefetchBufferLowerThreshold</a> (int32_t size)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_request_info.html#aaaf79f763cd4d72c8507c2fa19b7fcaf">SetCustomUserAgent</a> (const <a class="el" href="classpp_1_1_var.html">Var</a> &amp;user_agent)</td></tr>
</table>
<hr /><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classpp_1_1_u_r_l_request_info.html" title="URLRequestInfo provides an API for creating and manipulating URL requests.">URLRequestInfo</a> provides an API for creating and manipulating URL requests. </p>
</div><hr /><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="afd2068e004d90104cdc8472756d6131d"></a><!-- doxytag: member="pp::URLRequestInfo::URLRequestInfo" ref="afd2068e004d90104cdc8472756d6131d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpp_1_1_u_r_l_request_info.html#afd2068e004d90104cdc8472756d6131d">pp::URLRequestInfo::URLRequestInfo</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor. </p>
<p>This constructor creates an <code>is_null</code> resource. </p>
</div>
</div>
<a class="anchor" id="a95ae0d638a82bcd18318ae6340735321"></a><!-- doxytag: member="pp::URLRequestInfo::URLRequestInfo" ref="a95ae0d638a82bcd18318ae6340735321" args="(const InstanceHandle &amp;instance)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpp_1_1_u_r_l_request_info.html#afd2068e004d90104cdc8472756d6131d">pp::URLRequestInfo::URLRequestInfo</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpp_1_1_instance_handle.html">InstanceHandle</a> &amp;&#160;</td>
<td class="paramname"><em>instance</em></td><td>)</td>
<td><code> [explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A constructor used to allocate a new <code><a class="el" href="classpp_1_1_u_r_l_loader.html" title="URLLoader provides an API for loading URLs.">URLLoader</a></code> in the browser. </p>
<p>The resulting object will be <code>is_null</code> if the allocation failed.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">instance</td><td>The instance with which this resource will be associated. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a6f52f41f98fa5917addd412417b7d5d4"></a><!-- doxytag: member="pp::URLRequestInfo::URLRequestInfo" ref="a6f52f41f98fa5917addd412417b7d5d4" args="(const URLRequestInfo &amp;other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpp_1_1_u_r_l_request_info.html#afd2068e004d90104cdc8472756d6131d">pp::URLRequestInfo::URLRequestInfo</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpp_1_1_u_r_l_request_info.html">URLRequestInfo</a> &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The copy constructor for <code><a class="el" href="classpp_1_1_u_r_l_request_info.html" title="URLRequestInfo provides an API for creating and manipulating URL requests.">URLRequestInfo</a></code>. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>A <code><a class="el" href="classpp_1_1_u_r_l_request_info.html" title="URLRequestInfo provides an API for creating and manipulating URL requests.">URLRequestInfo</a></code> to be copied. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr /><h2>Member Function Documentation</h2>
<a class="anchor" id="ab16f2efba1f2ddc434e2fc860dcbe900"></a><!-- doxytag: member="pp::URLRequestInfo::AppendDataToBody" ref="ab16f2efba1f2ddc434e2fc860dcbe900" args="(const void *data, uint32_t len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classpp_1_1_u_r_l_request_info.html#ab16f2efba1f2ddc434e2fc860dcbe900">pp::URLRequestInfo::AppendDataToBody</a> </td>
<td>(</td>
<td class="paramtype">const void *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>len</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classpp_1_1_u_r_l_request_info.html#ab16f2efba1f2ddc434e2fc860dcbe900" title="AppendDataToBody() appends data to the request body.">AppendDataToBody()</a> appends data to the request body. </p>
<p>A content-length request header will be automatically generated.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>A pointer to a buffer holding the data. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>The length, in bytes, of the data.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if successful, false if any of the parameters are invalid. </dd></dl>
</div>
</div>
<a class="anchor" id="a1ae72c8ac65a6cd6c174c8df238038fd"></a><!-- doxytag: member="pp::URLRequestInfo::AppendFileRangeToBody" ref="a1ae72c8ac65a6cd6c174c8df238038fd" args="(const FileRef &amp;file_ref, int64_t start_offset, int64_t length, PP_Time expected_last_modified_time=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classpp_1_1_u_r_l_request_info.html#a1ae72c8ac65a6cd6c174c8df238038fd">pp::URLRequestInfo::AppendFileRangeToBody</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpp_1_1_file_ref.html">FileRef</a> &amp;&#160;</td>
<td class="paramname"><em>file_ref</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int64_t&#160;</td>
<td class="paramname"><em>start_offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int64_t&#160;</td>
<td class="paramname"><em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">PP_Time&#160;</td>
<td class="paramname"><em>expected_last_modified_time</em> = <code>0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classpp_1_1_u_r_l_request_info.html#a1ae72c8ac65a6cd6c174c8df238038fd" title="AppendFileRangeToBody() is a pointer to a function used to append part or all of a file...">AppendFileRangeToBody()</a> is a pointer to a function used to append part or all of a file, to be uploaded, to the request body. </p>
<p>A content-length request header will be automatically generated.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">file_ref</td><td>A <code><a class="el" href="classpp_1_1_file_ref.html" title='The FileRef class represents a "weak pointer" to a file in a file system.'>FileRef</a></code> containing the file reference. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">start_offset</td><td>An optional starting point offset within the file. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>An optional number of bytes of the file to be included. If the value is -1, then the sub-range to upload extends to the end of the file. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">expected_last_modified_time</td><td>An optional (non-zero) last modified time stamp used to validate that the file was not modified since the given time before it was uploaded. The upload will fail with an error code of <code>PP_ERROR_FILECHANGED</code> if the file has been modified since the given time. If expected_last_modified_time is 0, then no validation is performed.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if successful, false if any of the parameters are invalid. </dd></dl>
</div>
</div>
<a class="anchor" id="af19afd7e5849e68497f1e4f4b7400995"></a><!-- doxytag: member="pp::URLRequestInfo::AppendFileToBody" ref="af19afd7e5849e68497f1e4f4b7400995" args="(const FileRef &amp;file_ref, PP_Time expected_last_modified_time=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classpp_1_1_u_r_l_request_info.html#af19afd7e5849e68497f1e4f4b7400995">pp::URLRequestInfo::AppendFileToBody</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpp_1_1_file_ref.html">FileRef</a> &amp;&#160;</td>
<td class="paramname"><em>file_ref</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">PP_Time&#160;</td>
<td class="paramname"><em>expected_last_modified_time</em> = <code>0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classpp_1_1_u_r_l_request_info.html#af19afd7e5849e68497f1e4f4b7400995" title="AppendFileToBody() is used to append an entire file, to be uploaded, to the request body...">AppendFileToBody()</a> is used to append an entire file, to be uploaded, to the request body. </p>
<p>A content-length request header will be automatically generated.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">file_ref</td><td>A <code><a class="el" href="classpp_1_1_file_ref.html" title='The FileRef class represents a "weak pointer" to a file in a file system.'>FileRef</a></code> containing the file reference. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">expected_last_modified_time</td><td>An optional (non-zero) last modified time stamp used to validate that the file was not modified since the given time before it was uploaded. The upload will fail with an error code of <code>PP_ERROR_FILECHANGED</code> if the file has been modified since the given time. If expected_last_modified_time is 0, then no validation is performed.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if successful, false if any of the parameters are invalid. </dd></dl>
</div>
</div>
<a class="anchor" id="afa23501e503ee1787c4663d74f00d0c4"></a><!-- doxytag: member="pp::URLRequestInfo::SetAllowCredentials" ref="afa23501e503ee1787c4663d74f00d0c4" args="(bool enable)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classpp_1_1_u_r_l_request_info.html#afa23501e503ee1787c4663d74f00d0c4">pp::URLRequestInfo::SetAllowCredentials</a> </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>enable</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classpp_1_1_u_r_l_request_info.html#afa23501e503ee1787c4663d74f00d0c4" title="SetAllowCredentials() sets the PP_URLREQUESTPROPERTY_ALLOWCREDENTIALS (corresponding to a bool of typ...">SetAllowCredentials()</a> sets the <code>PP_URLREQUESTPROPERTY_ALLOWCREDENTIALS</code> (corresponding to a bool of type <code>PP_VARTYPE_BOOL</code>). </p>
<p>The default of the property is false. Whether HTTP credentials are sent with cross-origin requests. If false, no credentials are sent with the request and cookies are ignored in the response. If the request is not cross-origin, this property is ignored.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">enable</td><td>A <code>bool</code> containing the property value.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if successful, false if the parameter is invalid. </dd></dl>
</div>
</div>
<a class="anchor" id="a39a5000e734a378d412fbe87e38dabe4"></a><!-- doxytag: member="pp::URLRequestInfo::SetAllowCrossOriginRequests" ref="a39a5000e734a378d412fbe87e38dabe4" args="(bool enable)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classpp_1_1_u_r_l_request_info.html#a39a5000e734a378d412fbe87e38dabe4">pp::URLRequestInfo::SetAllowCrossOriginRequests</a> </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>enable</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classpp_1_1_u_r_l_request_info.html#a39a5000e734a378d412fbe87e38dabe4" title="SetAllowCrossOriginRequests() sets the PP_URLREQUESTPROPERTY_ALLOWCROSSORIGINREQUESTS (corresponding ...">SetAllowCrossOriginRequests()</a> sets the <code>PP_URLREQUESTPROPERTY_ALLOWCROSSORIGINREQUESTS</code> (corresponding to a bool of type <code>PP_VARTYPE_BOOL</code>). </p>
<p>The default of the property is false. Whether cross-origin requests are allowed. Cross-origin requests are made using the CORS (Cross-Origin <a class="el" href="classpp_1_1_resource.html" title="A reference counted module resource.">Resource</a> Sharing) algorithm to check whether the request should be allowed. For the complete CORS algorithm, refer to the <a href="http://www.w3.org/TR/access-control">Cross-Origin Resource Sharing</a> documentation.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">enable</td><td>A <code>bool</code> containing the property value.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if successful, false if the parameter is invalid. </dd></dl>
</div>
</div>
<a class="anchor" id="af25b7f4b3aa00af49140921d28fa09c9"></a><!-- doxytag: member="pp::URLRequestInfo::SetCustomContentTransferEncoding" ref="af25b7f4b3aa00af49140921d28fa09c9" args="(const Var &amp;content_transfer_encoding)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classpp_1_1_u_r_l_request_info.html#af25b7f4b3aa00af49140921d28fa09c9">pp::URLRequestInfo::SetCustomContentTransferEncoding</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpp_1_1_var.html">Var</a> &amp;&#160;</td>
<td class="paramname"><em>content_transfer_encoding</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classpp_1_1_u_r_l_request_info.html#af25b7f4b3aa00af49140921d28fa09c9" title="SetCustomContentTransferEncoding() sets the PP_URLREQUESTPROPERTY_CUSTOMCONTENTTRANSFERENCODING (corr...">SetCustomContentTransferEncoding()</a> sets the <code>PP_URLREQUESTPROPERTY_CUSTOMCONTENTTRANSFERENCODING</code> (corresponding to a string of type <code>PP_VARTYPE_STRING</code> or might be set to undefined as <code>PP_VARTYPE_UNDEFINED</code>). </p>
<p>Set it to a string to set a custom content-transfer-encoding header (if empty, that header will be omitted), or to undefined to use the default (if any). Only loaders with universal access (only available on trusted implementations) will accept <code><a class="el" href="classpp_1_1_u_r_l_request_info.html" title="URLRequestInfo provides an API for creating and manipulating URL requests.">URLRequestInfo</a></code> objects that try to set a custom content transfer encoding; if given to a loader without universal access, <code>PP_ERROR_BADARGUMENT</code> will result.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">content_transfer_encoding</td><td>A <code><a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code> containing the property value. To use the default content transfer encoding, set <code>content_transfer_encoding</code> to an undefined <code><a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if successful, false if the parameter is invalid. </dd></dl>
</div>
</div>
<a class="anchor" id="af6232dbb546c37c5438fadbada30353a"></a><!-- doxytag: member="pp::URLRequestInfo::SetCustomReferrerURL" ref="af6232dbb546c37c5438fadbada30353a" args="(const Var &amp;url)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classpp_1_1_u_r_l_request_info.html#af6232dbb546c37c5438fadbada30353a">pp::URLRequestInfo::SetCustomReferrerURL</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpp_1_1_var.html">Var</a> &amp;&#160;</td>
<td class="paramname"><em>url</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classpp_1_1_u_r_l_request_info.html#af6232dbb546c37c5438fadbada30353a" title="SetCustomReferrerURL() sets the PP_URLREQUESTPROPERTY_CUSTOMREFERRERURL (corresponding to a string of...">SetCustomReferrerURL()</a> sets the <code>PP_URLREQUESTPROPERTY_CUSTOMREFERRERURL</code> (corresponding to a string of type <code>PP_VARTYPE_STRING</code> or might be set to undefined as <code>PP_VARTYPE_UNDEFINED</code>). </p>
<p>Set it to a string to set a custom referrer (if empty, the referrer header will be omitted), or to undefined to use the default referrer. Only loaders with universal access (only available on trusted implementations) will accept <code><a class="el" href="classpp_1_1_u_r_l_request_info.html" title="URLRequestInfo provides an API for creating and manipulating URL requests.">URLRequestInfo</a></code> objects that try to set a custom referrer; if given to a loader without universal access, <code>PP_ERROR_BADARGUMENT</code> will result.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">url</td><td>A <code><a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code> containing the property value.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if successful, false if the parameter is invalid. </dd></dl>
</div>
</div>
<a class="anchor" id="aaaf79f763cd4d72c8507c2fa19b7fcaf"></a><!-- doxytag: member="pp::URLRequestInfo::SetCustomUserAgent" ref="aaaf79f763cd4d72c8507c2fa19b7fcaf" args="(const Var &amp;user_agent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classpp_1_1_u_r_l_request_info.html#aaaf79f763cd4d72c8507c2fa19b7fcaf">pp::URLRequestInfo::SetCustomUserAgent</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpp_1_1_var.html">Var</a> &amp;&#160;</td>
<td class="paramname"><em>user_agent</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classpp_1_1_u_r_l_request_info.html#aaaf79f763cd4d72c8507c2fa19b7fcaf" title="SetCustomUserAgent() sets the PP_URLREQUESTPROPERTY_CUSTOMUSERAGENT (corresponding to a string of typ...">SetCustomUserAgent()</a> sets the <code>PP_URLREQUESTPROPERTY_CUSTOMUSERAGENT</code> (corresponding to a string of type <code>PP_VARTYPE_STRING</code> or might be set to undefined as <code>PP_VARTYPE_UNDEFINED</code>). </p>
<p>Set it to a string to set a custom user-agent header (if empty, that header will be omitted), or to undefined to use the default. Only loaders with universal access (only available on trusted implementations) will accept <code><a class="el" href="classpp_1_1_u_r_l_request_info.html" title="URLRequestInfo provides an API for creating and manipulating URL requests.">URLRequestInfo</a></code> objects that try to set a custom user agent; if given to a loader without universal access, <code>PP_ERROR_BADARGUMENT</code> will result.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">user_agent</td><td>A <code><a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code> containing the property value. To use the default user agent, set <code>user_agent</code> to an undefined <code><a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if successful, false if the parameter is invalid. </dd></dl>
</div>
</div>
<a class="anchor" id="a72dd5d3b335a429af0ffa266e338a110"></a><!-- doxytag: member="pp::URLRequestInfo::SetFollowRedirects" ref="a72dd5d3b335a429af0ffa266e338a110" args="(bool enable)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classpp_1_1_u_r_l_request_info.html#a72dd5d3b335a429af0ffa266e338a110">pp::URLRequestInfo::SetFollowRedirects</a> </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>enable</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classpp_1_1_u_r_l_request_info.html#a72dd5d3b335a429af0ffa266e338a110" title="SetFollowRedirects() sets the PP_URLREQUESTPROPERTY_FOLLOWREDIRECT (corresponding to a bool of type P...">SetFollowRedirects()</a> sets the <code>PP_URLREQUESTPROPERTY_FOLLOWREDIRECT</code> (corresponding to a bool of type <code>PP_VARTYPE_BOOL</code>). </p>
<p>The default of the property is true. Set this value to false if you want to use URLLoader::FollowRedirects() to follow the redirects only after examining redirect headers.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">enable</td><td>A <code>bool</code> containing the property value.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if successful, false if the parameter is invalid. </dd></dl>
</div>
</div>
<a class="anchor" id="a7105409f66e2eb5595eec0e0ae07c4f6"></a><!-- doxytag: member="pp::URLRequestInfo::SetHeaders" ref="a7105409f66e2eb5595eec0e0ae07c4f6" args="(const Var &amp;headers_string)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classpp_1_1_u_r_l_request_info.html#a7105409f66e2eb5595eec0e0ae07c4f6">pp::URLRequestInfo::SetHeaders</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpp_1_1_var.html">Var</a> &amp;&#160;</td>
<td class="paramname"><em>headers_string</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classpp_1_1_u_r_l_request_info.html#a7105409f66e2eb5595eec0e0ae07c4f6" title="SetHeaders() sets the PP_URLREQUESTPROPERTY_HEADERS (corresponding to a delimited string of type PP...">SetHeaders()</a> sets the <code>PP_URLREQUESTPROPERTY_HEADERS</code> (corresponding to a <code><br />
</code> delimited string of type <code>PP_VARTYPE_STRING</code>) property for the request. </p>
<p>Refer to the &lt;a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"Header Field Definitions documentation for further information.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">headers_string</td><td>A <code><a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code> containing the property value.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if successful, false if the parameter is invalid. </dd></dl>
</div>
</div>
<a class="anchor" id="abf4024d196a5139dbca2e95b9ab9bdb6"></a><!-- doxytag: member="pp::URLRequestInfo::SetMethod" ref="abf4024d196a5139dbca2e95b9ab9bdb6" args="(const Var &amp;method_string)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classpp_1_1_u_r_l_request_info.html#abf4024d196a5139dbca2e95b9ab9bdb6">pp::URLRequestInfo::SetMethod</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpp_1_1_var.html">Var</a> &amp;&#160;</td>
<td class="paramname"><em>method_string</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classpp_1_1_u_r_l_request_info.html#abf4024d196a5139dbca2e95b9ab9bdb6" title="SetMethod() sets the PP_URLREQUESTPROPERTY_METHOD (corresponding to a string of type PP_VARTYPE_STRIN...">SetMethod()</a> sets the <code>PP_URLREQUESTPROPERTY_METHOD</code> (corresponding to a string of type <code>PP_VARTYPE_STRING</code>) property for the request. </p>
<p>This string is either a POST or GET. Refer to the <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec5.html">HTTP Methods</a> documentation for further information.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">method_string</td><td>A <code><a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code> containing the property value.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if successful, false if the parameter is invalid. </dd></dl>
</div>
</div>
<a class="anchor" id="a498fc64ad75ed2d44e33f2fdb3c0cad3"></a><!-- doxytag: member="pp::URLRequestInfo::SetPrefetchBufferLowerThreshold" ref="a498fc64ad75ed2d44e33f2fdb3c0cad3" args="(int32_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classpp_1_1_u_r_l_request_info.html#a498fc64ad75ed2d44e33f2fdb3c0cad3">pp::URLRequestInfo::SetPrefetchBufferLowerThreshold</a> </td>
<td>(</td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>size</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classpp_1_1_u_r_l_request_info.html#a498fc64ad75ed2d44e33f2fdb3c0cad3" title="SetPrefetchBufferLowerThreshold() sets the PP_URLREQUESTPROPERTY_PREFETCHBUFFERLOWERTHRESHOLD (corres...">SetPrefetchBufferLowerThreshold()</a> sets the <code>PP_URLREQUESTPROPERTY_PREFETCHBUFFERLOWERTHRESHOLD</code> (corresponding to a integer of type <code>PP_VARTYPE_INT32</code>). </p>
<p>The default is not defined and is set by the browser to a value appropriate for the default <code>PP_URLREQUESTPROPERTY_PREFETCHBUFFERUPPERTHRESHOLD</code>. Set it to an integer to set a lower threshold for the prefetched buffer of an asynchronous load. When reached, the browser will resume loading if If <code>PP_URLREQUESTPROPERTY_PREFETCHBUFFERLOWERERTHRESHOLD</code> had previously been reached. When setting this property, <code>PP_URLREQUESTPROPERTY_PREFETCHBUFFERUPPERTHRESHOLD</code> must also be set. Behavior is undefined if the former is &gt;= the latter.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>An int32_t containing the property value.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if successful, false if the parameter is invalid. </dd></dl>
</div>
</div>
<a class="anchor" id="aa2c6bb4f07e5372bd4b0ed49f9b67990"></a><!-- doxytag: member="pp::URLRequestInfo::SetPrefetchBufferUpperThreshold" ref="aa2c6bb4f07e5372bd4b0ed49f9b67990" args="(int32_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classpp_1_1_u_r_l_request_info.html#aa2c6bb4f07e5372bd4b0ed49f9b67990">pp::URLRequestInfo::SetPrefetchBufferUpperThreshold</a> </td>
<td>(</td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>size</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classpp_1_1_u_r_l_request_info.html#aa2c6bb4f07e5372bd4b0ed49f9b67990" title="SetPrefetchBufferUpperThreshold() sets the PP_URLREQUESTPROPERTY_PREFETCHBUFFERUPPERTHRESHOLD (corres...">SetPrefetchBufferUpperThreshold()</a> sets the <code>PP_URLREQUESTPROPERTY_PREFETCHBUFFERUPPERTHRESHOLD</code> (corresponding to a integer of type <code>PP_VARTYPE_INT32</code>). </p>
<p>The default is not defined and is set by the browser possibly depending on system capabilities. Set it to an integer to set an upper threshold for the prefetched buffer of an asynchronous load. When exceeded, the browser will defer loading until <code>PP_URLREQUESTPROPERTY_PREFETCHBUFFERLOWERERTHRESHOLD</code> is hit, at which time it will begin prefetching again. When setting this property, <code>PP_URLREQUESTPROPERTY_PREFETCHBUFFERLOWERERTHRESHOLD</code> must also be set. Behavior is undefined if the former is &lt;= the latter.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>An int32_t containing the property value.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if successful, false if the parameter is invalid. </dd></dl>
</div>
</div>
<a class="anchor" id="a679c2c4a7247e0b0985595c24e61cf9c"></a><!-- doxytag: member="pp::URLRequestInfo::SetProperty" ref="a679c2c4a7247e0b0985595c24e61cf9c" args="(PP_URLRequestProperty property, const Var &amp;value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classpp_1_1_u_r_l_request_info.html#a679c2c4a7247e0b0985595c24e61cf9c">pp::URLRequestInfo::SetProperty</a> </td>
<td>(</td>
<td class="paramtype">PP_URLRequestProperty&#160;</td>
<td class="paramname"><em>property</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classpp_1_1_var.html">Var</a> &amp;&#160;</td>
<td class="paramname"><em>value</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classpp_1_1_u_r_l_request_info.html#a679c2c4a7247e0b0985595c24e61cf9c" title="SetProperty() sets a request property.">SetProperty()</a> sets a request property. </p>
<p>The value of the property must be the correct type according to the property being set.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">property</td><td>A <code>PP_URLRequestProperty</code> identifying the property to set. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>A <code><a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code> containing the property value.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if successful, false if any of the parameters are invalid. </dd></dl>
</div>
</div>
<a class="anchor" id="aca69393ce31673c1cc5407d15774e310"></a><!-- doxytag: member="pp::URLRequestInfo::SetRecordDownloadProgress" ref="aca69393ce31673c1cc5407d15774e310" args="(bool enable)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classpp_1_1_u_r_l_request_info.html#aca69393ce31673c1cc5407d15774e310">pp::URLRequestInfo::SetRecordDownloadProgress</a> </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>enable</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classpp_1_1_u_r_l_request_info.html#aca69393ce31673c1cc5407d15774e310" title="SetRecordDownloadProgress() sets the PP_URLREQUESTPROPERTY_RECORDDOWNLOADPROGESS (corresponding to a ...">SetRecordDownloadProgress()</a> sets the <code>PP_URLREQUESTPROPERTY_RECORDDOWNLOADPROGESS</code> (corresponding to a bool of type <code>PP_VARTYPE_BOOL</code>). </p>
<p>The default of the property is false. Set this value to true if you want to be able to poll the download progress using <a class="el" href="classpp_1_1_u_r_l_loader.html#ada4a1757e7883912626e2ece85ec1c53" title="This function returns the current download progress, which is meaningful after Open() has been called...">URLLoader::GetDownloadProgress()</a>.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">enable</td><td>A <code>bool</code> containing the property value.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if successful, false if the parameter is invalid. </dd></dl>
</div>
</div>
<a class="anchor" id="a52cfef994077173627a809bdf891e01a"></a><!-- doxytag: member="pp::URLRequestInfo::SetRecordUploadProgress" ref="a52cfef994077173627a809bdf891e01a" args="(bool enable)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classpp_1_1_u_r_l_request_info.html#a52cfef994077173627a809bdf891e01a">pp::URLRequestInfo::SetRecordUploadProgress</a> </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>enable</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classpp_1_1_u_r_l_request_info.html#a52cfef994077173627a809bdf891e01a" title="SetRecordUploadProgress() sets the PP_URLREQUESTPROPERTY_RECORDUPLOADPROGRESS (corresponding to a boo...">SetRecordUploadProgress()</a> sets the <code>PP_URLREQUESTPROPERTY_RECORDUPLOADPROGRESS</code> (corresponding to a bool of type <code>PP_VARTYPE_BOOL</code>). </p>
<p>The default of the property is false. Set this value to true if you want to be able to poll the upload progress using <a class="el" href="classpp_1_1_u_r_l_loader.html#a5e3723f5c5d10394329899f75121faf1" title="This function returns the current upload progress (which is only meaningful after Open() has been cal...">URLLoader::GetUploadProgress()</a>.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">enable</td><td>A <code>bool</code> containing the property value.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if successful, false if the parameter is invalid. </dd></dl>
</div>
</div>
<a class="anchor" id="a7bd36cb47bc0bc3579292f81581359b8"></a><!-- doxytag: member="pp::URLRequestInfo::SetStreamToFile" ref="a7bd36cb47bc0bc3579292f81581359b8" args="(bool enable)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classpp_1_1_u_r_l_request_info.html#a7bd36cb47bc0bc3579292f81581359b8">pp::URLRequestInfo::SetStreamToFile</a> </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>enable</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classpp_1_1_u_r_l_request_info.html#a7bd36cb47bc0bc3579292f81581359b8" title="SetStreamToFile() sets the PP_URLREQUESTPROPERTY_STREAMTOFILE (corresponding to a bool of type PP_VAR...">SetStreamToFile()</a> sets the <code>PP_URLREQUESTPROPERTY_STREAMTOFILE</code> (corresponding to a bool of type <code>PP_VARTYPE_BOOL</code>). </p>
<p>The default of the property is false. Set this value to true if you want to download the data to a file. Use URL_Loader::FinishStreamingToFile() to complete the download.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">enable</td><td>A <code>bool</code> containing the property value.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if successful, false if the parameter is invalid. </dd></dl>
</div>
</div>
<a class="anchor" id="a97cdeb02a63922704d47c585a4e2baaf"></a><!-- doxytag: member="pp::URLRequestInfo::SetURL" ref="a97cdeb02a63922704d47c585a4e2baaf" args="(const Var &amp;url_string)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classpp_1_1_u_r_l_request_info.html#a97cdeb02a63922704d47c585a4e2baaf">pp::URLRequestInfo::SetURL</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpp_1_1_var.html">Var</a> &amp;&#160;</td>
<td class="paramname"><em>url_string</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classpp_1_1_u_r_l_request_info.html#a97cdeb02a63922704d47c585a4e2baaf" title="SetURL() sets the PP_URLREQUESTPROPERTY_URL property for the request.">SetURL()</a> sets the <code>PP_URLREQUESTPROPERTY_URL</code> property for the request. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">url_string</td><td>A <code><a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code> containing the property value.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if successful, false if the parameter is invalid. </dd></dl>
</div>
</div>
<hr />The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="url__request__info_8h.html">url_request_info.h</a></li>
</ul>
</div><!-- contents -->
</div>
{{/partials.standard_nacl_api}}