Amebis/WinStd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
WinStd/_win_h_t_t_p_8h_source.html

181 lines
18 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>WinStd: include/WinStd/WinHTTP.h Source File</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>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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 id="projectrow">
<td id="projectalign">
<div id="projectname">WinStd
</div>
<div id="projectbrief">Windows Win32 API using Standard C++</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_6f50bb204833d887b928571856c82fbe.html">WinStd</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">WinHTTP.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> SPDX-License-Identifier: MIT</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> Copyright © 1991-2024 Amebis</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> Copyright © 2016 GÉANT</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment">*/</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include &quot;Common.h&quot;</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#include &lt;winhttp.h&gt;</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> </div>
<div class="foldopen" id="foldopen00023" data-start="{" data-end="}">
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="group___win_std_win_h_t_t_p.html#gafc5f6410cfa802b5bcb35ad754b95178"> 23</a></span><span class="keyword">inline</span> _Success_(<span class="keywordflow">return</span>) BOOL <a class="code hl_function" href="group___win_std_win_h_t_t_p.html#gafc5f6410cfa802b5bcb35ad754b95178">WinHttpQueryHeaders</a>(_In_ HINTERNET hRequest, _In_ DWORD dwInfoLevel, _Out_ DWORD&amp; dwData)</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span>{</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> DWORD dwSize = <span class="keyword">sizeof</span>(dwData);</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <span class="keywordflow">if</span> (<a class="code hl_function" href="group___win_std_win_h_t_t_p.html#gafc5f6410cfa802b5bcb35ad754b95178">WinHttpQueryHeaders</a>(hRequest, dwInfoLevel | WINHTTP_QUERY_FLAG_NUMBER, WINHTTP_HEADER_NAME_BY_INDEX, &amp;dwData, &amp;dwSize, WINHTTP_NO_HEADER_INDEX)) {</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> assert(dwSize == <span class="keyword">sizeof</span>(dwData));</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keywordflow">return</span> TRUE;</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> }</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="keywordflow">return</span> FALSE;</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span>}</div>
</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="foldopen" id="foldopen00038" data-start="{" data-end="}">
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="group___win_std_win_h_t_t_p.html#ga3c0714f24f5ce35d3db8a26cabb8e429"> 38</a></span><span class="keyword">inline</span> _Success_(<span class="keywordflow">return</span>) BOOL <a class="code hl_function" href="group___win_std_win_h_t_t_p.html#gafc5f6410cfa802b5bcb35ad754b95178">WinHttpQueryHeaders</a>(_In_ HINTERNET hRequest, _In_ DWORD dwInfoLevel, _Inout_ std::wstring&amp; sData)</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span>{</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> DWORD dwSize = 0x100;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keywordflow">for</span> (;;) {</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> sData.resize(dwSize - 1);</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> dwSize *= <span class="keyword">sizeof</span>(WCHAR);</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keywordflow">if</span> (<a class="code hl_function" href="group___win_std_win_h_t_t_p.html#gafc5f6410cfa802b5bcb35ad754b95178">WinHttpQueryHeaders</a>(hRequest, dwInfoLevel, WINHTTP_HEADER_NAME_BY_INDEX, sData.data(), &amp;dwSize, WINHTTP_NO_HEADER_INDEX)) {</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> dwSize /= <span class="keyword">sizeof</span>(WCHAR);</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> sData.resize(dwSize);</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keywordflow">return</span> TRUE;</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> }</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> DWORD result = GetLastError();</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="keywordflow">if</span> (result == ERROR_NOT_ENOUGH_MEMORY) {</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> dwSize /= <span class="keyword">sizeof</span>(WCHAR);</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> dwSize *= 2;</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> }</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="keywordflow">else</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keywordflow">return</span> FALSE;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> }</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span>}</div>
</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="keyword">namespace </span>winstd</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span>{</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> </div>
<div class="foldopen" id="foldopen00071" data-start="{" data-end="};">
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"><a class="line" href="classwinstd_1_1http.html"> 71</a></span> <span class="keyword">class </span><a class="code hl_class" href="classwinstd_1_1http.html">http</a> : <span class="keyword">public</span> <a class="code hl_class" href="classwinstd_1_1handle.html">handle</a>&lt;HINTERNET, NULL&gt;</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> {</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <a class="code hl_define" href="group___win_std_sys_handles.html#ga51471bfe41853b66ac0f44df97cfaaa6">WINSTD_HANDLE_IMPL</a>(<a class="code hl_class" href="classwinstd_1_1http.html">http</a>, <a class="code hl_class" href="classwinstd_1_1ref__unique__ptr.html">HINTERNET</a>, <a class="code hl_class" href="classwinstd_1_1ref__unique__ptr.html">NULL</a>)</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="keyword">public</span>:</div>
<div class="foldopen" id="foldopen00081" data-start="{" data-end="}">
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"><a class="line" href="classwinstd_1_1http.html#a0dd8f655e3581cba346dfdc86e945580"> 81</a></span> <span class="keyword">virtual</span> <a class="code hl_function" href="classwinstd_1_1http.html#a0dd8f655e3581cba346dfdc86e945580">~http</a>()</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> {</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <span class="keywordflow">if</span> (<a class="code hl_variable" href="classwinstd_1_1handle.html#aabde3f16fd98b06b3b0282ef7806eb59">m_h</a> != <a class="code hl_variable" href="group___win_std_sys_handles.html#gacf43e306968474166474090690857e1c">invalid</a>)</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <a class="code hl_function" href="classwinstd_1_1http.html#adb1a08aed51b8203b23c874e167b6248">free_internal</a>();</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> }</div>
</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> </div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <span class="keyword">protected</span>:</div>
<div class="foldopen" id="foldopen00093" data-start="{" data-end="}">
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"><a class="line" href="classwinstd_1_1http.html#adb1a08aed51b8203b23c874e167b6248"> 93</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classwinstd_1_1http.html#adb1a08aed51b8203b23c874e167b6248">free_internal</a>() <a class="code hl_class" href="classwinstd_1_1ref__unique__ptr.html">noexcept</a><span class="keyword"> override</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> <a class="code hl_class" href="classwinstd_1_1ref__unique__ptr.html">WinHttpCloseHandle</a>(<a class="code hl_variable" href="classwinstd_1_1handle.html#aabde3f16fd98b06b3b0282ef7806eb59">m_h</a>);</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> }</div>
</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> };</div>
</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> </div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span>}</div>
<div class="ttc" id="aclasswinstd_1_1handle_html"><div class="ttname"><a href="classwinstd_1_1handle.html">winstd::handle</a></div><div class="ttdoc">Base abstract template class to support generic object handle keeping.</div><div class="ttdef"><b>Definition</b> Common.h:1024</div></div>
<div class="ttc" id="aclasswinstd_1_1handle_html_aabde3f16fd98b06b3b0282ef7806eb59"><div class="ttname"><a href="classwinstd_1_1handle.html#aabde3f16fd98b06b3b0282ef7806eb59">winstd::handle&lt; HINTERNET, NULL &gt;::m_h</a></div><div class="ttdeci">handle_type m_h</div><div class="ttdoc">Object handle.</div><div class="ttdef"><b>Definition</b> Common.h:1276</div></div>
<div class="ttc" id="aclasswinstd_1_1http_html"><div class="ttname"><a href="classwinstd_1_1http.html">winstd::http</a></div><div class="ttdoc">HTTP handle wrapper class.</div><div class="ttdef"><b>Definition</b> WinHTTP.h:72</div></div>
<div class="ttc" id="aclasswinstd_1_1http_html_a0dd8f655e3581cba346dfdc86e945580"><div class="ttname"><a href="classwinstd_1_1http.html#a0dd8f655e3581cba346dfdc86e945580">winstd::http::~http</a></div><div class="ttdeci">virtual ~http()</div><div class="ttdoc">Closes a handle to the HTTP.</div><div class="ttdef"><b>Definition</b> WinHTTP.h:81</div></div>
<div class="ttc" id="aclasswinstd_1_1http_html_adb1a08aed51b8203b23c874e167b6248"><div class="ttname"><a href="classwinstd_1_1http.html#adb1a08aed51b8203b23c874e167b6248">winstd::http::free_internal</a></div><div class="ttdeci">void free_internal() noexcept override</div><div class="ttdoc">Closes a handle to the HTTP.</div><div class="ttdef"><b>Definition</b> WinHTTP.h:93</div></div>
<div class="ttc" id="aclasswinstd_1_1ref__unique__ptr_html"><div class="ttname"><a href="classwinstd_1_1ref__unique__ptr.html">winstd::ref_unique_ptr</a></div><div class="ttdoc">Helper class for returning pointers to std::unique_ptr.</div><div class="ttdef"><b>Definition</b> Common.h:863</div></div>
<div class="ttc" id="agroup___win_std_sys_handles_html_ga51471bfe41853b66ac0f44df97cfaaa6"><div class="ttname"><a href="group___win_std_sys_handles.html#ga51471bfe41853b66ac0f44df97cfaaa6">WINSTD_HANDLE_IMPL</a></div><div class="ttdeci">#define WINSTD_HANDLE_IMPL(C, T, INVAL)</div><div class="ttdoc">Implements default constructors and operators to prevent their auto-generation by compiler.</div><div class="ttdef"><b>Definition</b> Common.h:164</div></div>
<div class="ttc" id="agroup___win_std_sys_handles_html_gacf43e306968474166474090690857e1c"><div class="ttname"><a href="group___win_std_sys_handles.html#gacf43e306968474166474090690857e1c">winstd::handle&lt; HINTERNET, NULL &gt;::invalid</a></div><div class="ttdeci">static const HINTERNET invalid</div><div class="ttdoc">Invalid handle value.</div><div class="ttdef"><b>Definition</b> Common.h:1034</div></div>
<div class="ttc" id="agroup___win_std_win_h_t_t_p_html_gafc5f6410cfa802b5bcb35ad754b95178"><div class="ttname"><a href="group___win_std_win_h_t_t_p.html#gafc5f6410cfa802b5bcb35ad754b95178">WinHttpQueryHeaders</a></div><div class="ttdeci">BOOL WinHttpQueryHeaders(HINTERNET hRequest, DWORD dwInfoLevel, DWORD &amp;dwData)</div><div class="ttdoc">Retrieves header information associated with an HTTP request.</div><div class="ttdef"><b>Definition</b> WinHTTP.h:23</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Mar 11 2024 20:42:49 for WinStd by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink