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

243 lines
12 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">
<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.9.3"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>WinStd: winstd::com_initializer 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="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">Additional templates and function helpers for Microsoft Windows using Standard C++ classes</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.3 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'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');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>winstd</b></li><li class="navelem"><a class="el" href="classwinstd_1_1com__initializer.html">com_initializer</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classwinstd_1_1com__initializer-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">winstd::com_initializer Class Reference<div class="ingroups"><a class="el" href="group___win_std_c_o_m.html">COM object management</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Context scope automatic COM (un)initialization.
<a href="classwinstd_1_1com__initializer.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_c_o_m_8h_source.html">WinStd/COM.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2e1dceaa4a658f2d35b93fe85d71e109"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1com__initializer.html#a2e1dceaa4a658f2d35b93fe85d71e109">com_initializer</a> (LPVOID pvReserved) noexcept</td></tr>
<tr class="memdesc:a2e1dceaa4a658f2d35b93fe85d71e109"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the COM library on the current thread and identifies the concurrency model as single-thread apartment (STA). <a href="classwinstd_1_1com__initializer.html#a2e1dceaa4a658f2d35b93fe85d71e109">More...</a><br /></td></tr>
<tr class="separator:a2e1dceaa4a658f2d35b93fe85d71e109"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a20c89f6e237eb97166aac61f0dbdcbf6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1com__initializer.html#a20c89f6e237eb97166aac61f0dbdcbf6">com_initializer</a> (LPVOID pvReserved, DWORD dwCoInit) noexcept</td></tr>
<tr class="memdesc:a20c89f6e237eb97166aac61f0dbdcbf6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the COM library for use by the calling thread, sets the thread's concurrency model, and creates a new apartment for the thread if one is required. <a href="classwinstd_1_1com__initializer.html#a20c89f6e237eb97166aac61f0dbdcbf6">More...</a><br /></td></tr>
<tr class="separator:a20c89f6e237eb97166aac61f0dbdcbf6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad53a7697dfaf83d4832f8a57a4cf00f6"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1com__initializer.html#ad53a7697dfaf83d4832f8a57a4cf00f6">~com_initializer</a> ()</td></tr>
<tr class="memdesc:ad53a7697dfaf83d4832f8a57a4cf00f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Uninitializes COM. <a href="classwinstd_1_1com__initializer.html#ad53a7697dfaf83d4832f8a57a4cf00f6">More...</a><br /></td></tr>
<tr class="separator:ad53a7697dfaf83d4832f8a57a4cf00f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac3c997f810e8439096d8ca14fecb5b7d"><td class="memItemLeft" align="right" valign="top">HRESULT&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1com__initializer.html#ac3c997f810e8439096d8ca14fecb5b7d">status</a> () const noexcept</td></tr>
<tr class="memdesc:ac3c997f810e8439096d8ca14fecb5b7d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return result of <code>CoInitialize()</code> call. <a href="classwinstd_1_1com__initializer.html#ac3c997f810e8439096d8ca14fecb5b7d">More...</a><br /></td></tr>
<tr class="separator:ac3c997f810e8439096d8ca14fecb5b7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:ae9478fd05b5b1c82e0f762c2b517155b"><td class="memItemLeft" align="right" valign="top"><a id="ae9478fd05b5b1c82e0f762c2b517155b" name="ae9478fd05b5b1c82e0f762c2b517155b"></a>
HRESULT&#160;</td><td class="memItemRight" valign="bottom"><b>m_result</b></td></tr>
<tr class="memdesc:ae9478fd05b5b1c82e0f762c2b517155b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Result of CoInitialize call. <br /></td></tr>
<tr class="separator:ae9478fd05b5b1c82e0f762c2b517155b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Context scope automatic COM (un)initialization. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a2e1dceaa4a658f2d35b93fe85d71e109" name="a2e1dceaa4a658f2d35b93fe85d71e109"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2e1dceaa4a658f2d35b93fe85d71e109">&#9670;&nbsp;</a></span>com_initializer() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">winstd::com_initializer::com_initializer </td>
<td>(</td>
<td class="paramtype">LPVOID&#160;</td>
<td class="paramname"><em>pvReserved</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes the COM library on the current thread and identifies the concurrency model as single-thread apartment (STA). </p>
<dl class="section see"><dt>See also</dt><dd><a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms678543.aspx">CoInitialize function</a> </dd></dl>
</div>
</div>
<a id="a20c89f6e237eb97166aac61f0dbdcbf6" name="a20c89f6e237eb97166aac61f0dbdcbf6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a20c89f6e237eb97166aac61f0dbdcbf6">&#9670;&nbsp;</a></span>com_initializer() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">winstd::com_initializer::com_initializer </td>
<td>(</td>
<td class="paramtype">LPVOID&#160;</td>
<td class="paramname"><em>pvReserved</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">DWORD&#160;</td>
<td class="paramname"><em>dwCoInit</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes the COM library for use by the calling thread, sets the thread's concurrency model, and creates a new apartment for the thread if one is required. </p>
<dl class="section see"><dt>See also</dt><dd><a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms695279.aspx">CoInitializeEx function</a> </dd></dl>
</div>
</div>
<a id="ad53a7697dfaf83d4832f8a57a4cf00f6" name="ad53a7697dfaf83d4832f8a57a4cf00f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad53a7697dfaf83d4832f8a57a4cf00f6">&#9670;&nbsp;</a></span>~com_initializer()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual winstd::com_initializer::~com_initializer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Uninitializes COM. </p>
<dl class="section see"><dt>See also</dt><dd><a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms688715.aspx">CoUninitialize function</a> </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ac3c997f810e8439096d8ca14fecb5b7d" name="ac3c997f810e8439096d8ca14fecb5b7d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac3c997f810e8439096d8ca14fecb5b7d">&#9670;&nbsp;</a></span>status()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">HRESULT winstd::com_initializer::status </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return result of <code>CoInitialize()</code> call. </p>
<dl class="section see"><dt>See also</dt><dd><a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms678543.aspx">CoInitialize function</a> </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/WinStd/<a class="el" href="_c_o_m_8h_source.html">COM.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Mar 7 2022 09:10:52 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.9.3
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink