1 {{+bindTo:partials.standard_nacl_article}}
2 <h1>PPB_URLResponseInfo Struct Reference</h1>
4 <!-- Generated by Doxygen 1.7.6.1 -->
10 <!-- doxytag: class="PPB_URLResponseInfo" --><h2>
11 Data Fields</h2><table class="memberdecls">
13 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___u_r_l_response_info__1__0.html#a0bb553375716a3966176ae01f6146d5a">IsURLResponseInfo</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource)</td></tr>
14 <tr><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="struct_p_p___var.html">PP_Var</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___u_r_l_response_info__1__0.html#a3fff27f7102320e9efbd59dc83e62ddf">GetProperty</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> response, <a class="el" href="group___enums.html#ga642e6199b27df69aad84aff5597041e0">PP_URLResponseProperty</a> property)</td></tr>
15 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___u_r_l_response_info__1__0.html#a5c826b8217ceede947eda843e0566d2b">GetBodyAsFileRef</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> response)</td></tr>
17 <hr /><a name="details" id="details"></a><h2>Detailed Description</h2>
18 <div class="textblock"><p>The PPB_URLResponseInfo interface contains APIs for examining URL responses. </p>
19 <p>Refer to <code>PPB_URLLoader</code> for further information. </p>
20 </div><hr /><h2>Field Documentation</h2>
21 <a class="anchor" id="a5c826b8217ceede947eda843e0566d2b"></a><!-- doxytag: member="PPB_URLResponseInfo::GetBodyAsFileRef" ref="a5c826b8217ceede947eda843e0566d2b" args=")(PP_Resource response)" -->
23 <div class="memproto">
24 <table class="memname">
26 <td class="memname"><a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a>(* <a class="el" href="struct_p_p_b___u_r_l_response_info__1__0.html#a5c826b8217ceede947eda843e0566d2b">PPB_URLResponseInfo::GetBodyAsFileRef</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> response)</td>
31 <p><a class="el" href="struct_p_p_b___u_r_l_response_info__1__0.html#a5c826b8217ceede947eda843e0566d2b" title="GetBodyAsFileRef() returns a FileRef pointing to the file containing the response body...">GetBodyAsFileRef()</a> returns a FileRef pointing to the file containing the response body. </p>
32 <p>This is only valid if <code>PP_URLREQUESTPROPERTY_STREAMTOFILE</code> was set on the <code>URLRequestInfo</code> used to produce this response. This file remains valid until the <code>URLLoader</code> associated with this <code>URLResponseInfo</code> is closed or destroyed.</p>
33 <dl class="params"><dt><b>Parameters:</b></dt><dd>
34 <table class="params">
35 <tr><td class="paramdir">[in]</td><td class="paramname">request</td><td>A <code>PP_Resource</code> corresponding to a <code>URLResponseInfo</code>.</td></tr>
39 <dl class="return"><dt><b>Returns:</b></dt><dd>A <code>PP_Resource</code> corresponding to a <code>FileRef</code> if successful, 0 if <code>PP_URLREQUESTPROPERTY_STREAMTOFILE</code> was not requested or if the <code>URLLoader</code> has not been opened yet. </dd></dl>
42 <a class="anchor" id="a3fff27f7102320e9efbd59dc83e62ddf"></a><!-- doxytag: member="PPB_URLResponseInfo::GetProperty" ref="a3fff27f7102320e9efbd59dc83e62ddf" args=")(PP_Resource response, PP_URLResponseProperty property)" -->
44 <div class="memproto">
45 <table class="memname">
47 <td class="memname">struct <a class="el" href="struct_p_p___var.html">PP_Var</a>(* <a class="el" href="struct_p_p_b___u_r_l_response_info__1__0.html#a3fff27f7102320e9efbd59dc83e62ddf">PPB_URLResponseInfo::GetProperty</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> response, <a class="el" href="group___enums.html#ga642e6199b27df69aad84aff5597041e0">PP_URLResponseProperty</a> property)<code> [read]</code></td>
52 <p><a class="el" href="struct_p_p_b___u_r_l_response_info__1__0.html#a3fff27f7102320e9efbd59dc83e62ddf" title="GetProperty() gets a response property.">GetProperty()</a> gets a response property. </p>
53 <dl class="params"><dt><b>Parameters:</b></dt><dd>
54 <table class="params">
55 <tr><td class="paramdir">[in]</td><td class="paramname">request</td><td>A <code>PP_Resource</code> corresponding to a <code>URLResponseInfo</code>. </td></tr>
56 <tr><td class="paramdir">[in]</td><td class="paramname">property</td><td>A <code>PP_URLResponseProperty</code> identifying the type of property in the response.</td></tr>
60 <dl class="return"><dt><b>Returns:</b></dt><dd>A <code><a class="el" href="struct_p_p___var.html" title="The PP_VAR struct is a variant data type and can contain any value of one of the types named in the P...">PP_Var</a></code> containing the response property value if successful, <code>PP_VARTYPE_VOID</code> if an input parameter is invalid. </dd></dl>
63 <a class="anchor" id="a0bb553375716a3966176ae01f6146d5a"></a><!-- doxytag: member="PPB_URLResponseInfo::IsURLResponseInfo" ref="a0bb553375716a3966176ae01f6146d5a" args=")(PP_Resource resource)" -->
65 <div class="memproto">
66 <table class="memname">
68 <td class="memname"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(* <a class="el" href="struct_p_p_b___u_r_l_response_info__1__0.html#a0bb553375716a3966176ae01f6146d5a">PPB_URLResponseInfo::IsURLResponseInfo</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource)</td>
73 <p><a class="el" href="struct_p_p_b___u_r_l_response_info__1__0.html#a0bb553375716a3966176ae01f6146d5a" title="IsURLResponseInfo() determines if a response is a URLResponseInfo.">IsURLResponseInfo()</a> determines if a response is a <code>URLResponseInfo</code>. </p>
74 <dl class="params"><dt><b>Parameters:</b></dt><dd>
75 <table class="params">
76 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PP_Resource</code> corresponding to a <code>URLResponseInfo</code>.</td></tr>
80 <dl class="return"><dt><b>Returns:</b></dt><dd><code>PP_TRUE</code> if the resource is a <code>URLResponseInfo</code>, <code>PP_FALSE</code> if the resource is invalid or some type other than <code>URLResponseInfo</code>. </dd></dl>
83 <hr />The documentation for this struct was generated from the following file:<ul>
84 <li><a class="el" href="ppb__url__response__info_8h.html">ppb_url_response_info.h</a></li>
86 </div><!-- contents -->
87 {{/partials.standard_nacl_article}}