wxExtend/classwx_co_initializer.html

207 lines
9.5 KiB
HTML

<!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>wxExtend: wxCoInitializer 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>
<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">wxExtend
</div>
<div id="projectbrief">Additional templates and function helpers for wxWidgets</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>
<!-- 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classwx_co_initializer-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">wxCoInitializer Class Reference<div class="ingroups"><a class="el" href="group__wx_extend.html">WxExtend</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Create an object of this class on stack to initialize/cleanup the COM automatically.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="comutils_8h_source.html">wxex/comutils.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:a46b112d54217cf254e396dec121d177f" id="r_a46b112d54217cf254e396dec121d177f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a46b112d54217cf254e396dec121d177f">wxCoInitializer</a> (DWORD dwCoInit=COINIT_MULTITHREADED)</td></tr>
<tr class="memdesc:a46b112d54217cf254e396dec121d177f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the COM. <br /></td></tr>
<tr class="separator:a46b112d54217cf254e396dec121d177f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab1237d26d2fc2c988843d314f4a1da23" id="r_ab1237d26d2fc2c988843d314f4a1da23"><td class="memItemLeft" align="right" valign="top"><a id="ab1237d26d2fc2c988843d314f4a1da23" name="ab1237d26d2fc2c988843d314f4a1da23"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><b>~wxCoInitializer</b> ()</td></tr>
<tr class="memdesc:ab1237d26d2fc2c988843d314f4a1da23"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dtor clean up. <br /></td></tr>
<tr class="separator:ab1237d26d2fc2c988843d314f4a1da23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac99d618e4222add9f165b58f6ce67c34" id="r_ac99d618e4222add9f165b58f6ce67c34"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac99d618e4222add9f165b58f6ce67c34">IsOk</a> () const</td></tr>
<tr class="memdesc:ac99d618e4222add9f165b58f6ce67c34"><td class="mdescLeft">&#160;</td><td class="mdescRight">Has the initialization been successful? (explicit test) <br /></td></tr>
<tr class="separator:ac99d618e4222add9f165b58f6ce67c34"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b35d0b8e75e96b50af749b686651fd9" id="r_a0b35d0b8e75e96b50af749b686651fd9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0b35d0b8e75e96b50af749b686651fd9">operator bool</a> () const</td></tr>
<tr class="memdesc:a0b35d0b8e75e96b50af749b686651fd9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Has the initialization been successful? (implicit test) <br /></td></tr>
<tr class="separator:a0b35d0b8e75e96b50af749b686651fd9"><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>Create an object of this class on stack to initialize/cleanup the COM automatically. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a46b112d54217cf254e396dec121d177f" name="a46b112d54217cf254e396dec121d177f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a46b112d54217cf254e396dec121d177f">&#9670;&#160;</a></span>wxCoInitializer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">wxCoInitializer::wxCoInitializer </td>
<td>(</td>
<td class="paramtype">DWORD</td> <td class="paramname"><span class="paramname"><em>dwCoInit</em><span class="paramdefsep"> = </span><span class="paramdefval">COINIT_MULTITHREADED</span></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the COM. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dwCoInit</td><td>The concurrency model and initialization options for the thread to pass to <code>CoInitializeEx()</code> </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ac99d618e4222add9f165b58f6ce67c34" name="ac99d618e4222add9f165b58f6ce67c34"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac99d618e4222add9f165b58f6ce67c34">&#9670;&#160;</a></span>IsOk()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool wxCoInitializer::IsOk </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Has the initialization been successful? (explicit test) </p>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li><code>true</code> if initialization succeeded</li>
<li><code>false</code> otherwise </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a0b35d0b8e75e96b50af749b686651fd9" name="a0b35d0b8e75e96b50af749b686651fd9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b35d0b8e75e96b50af749b686651fd9">&#9670;&#160;</a></span>operator bool()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">wxCoInitializer::operator bool </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Has the initialization been successful? (implicit test) </p>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li><code>true</code> if initialization succeeded</li>
<li><code>false</code> otherwise </li>
</ul>
</dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/wxex/<a class="el" href="comutils_8h_source.html">comutils.h</a></li>
<li>src/<b>comutils.cpp</b></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Mar 11 2024 14:56:54 for wxExtend 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>