309 lines
32 KiB
HTML
309 lines
32 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">
|
|
<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::event 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&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&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_1event.html">event</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classwinstd_1_1event-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">winstd::event Class Reference<div class="ingroups"><a class="el" href="group___win_std_win_a_p_i.html">Windows API</a></div></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Event handle wrapper.
|
|
<a href="classwinstd_1_1event.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_win_8h_source.html">WinStd/Win.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for winstd::event:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classwinstd_1_1event.png" usemap="#winstd::event_map" alt=""/>
|
|
<map id="winstd::event_map" name="winstd::event_map">
|
|
<area href="classwinstd_1_1win__handle.html" alt="winstd::win_handle< NULL >" shape="rect" coords="0,56,224,80"/>
|
|
<area href="classwinstd_1_1handle.html" alt="winstd::handle< HANDLE, INVALID >" shape="rect" coords="0,0,224,24"/>
|
|
</map>
|
|
</div></div>
|
|
<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:a97d7be96a11e0b5232db73e7cb5d1395"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1event.html#a97d7be96a11e0b5232db73e7cb5d1395">create</a> (BOOL bManualReset, BOOL bInitialState, LPSECURITY_ATTRIBUTES lpEventAttributes=NULL, LPCTSTR lpName=NULL) noexcept</td></tr>
|
|
<tr class="memdesc:a97d7be96a11e0b5232db73e7cb5d1395"><td class="mdescLeft"> </td><td class="mdescRight">Creates or opens a named or unnamed event object. <a href="classwinstd_1_1event.html#a97d7be96a11e0b5232db73e7cb5d1395">More...</a><br /></td></tr>
|
|
<tr class="separator:a97d7be96a11e0b5232db73e7cb5d1395"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a208402e837b0663e6f2a4babbc555145"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1event.html#a208402e837b0663e6f2a4babbc555145">open</a> (DWORD dwDesiredAccess, BOOL bInheritHandle, LPCTSTR lpName) noexcept</td></tr>
|
|
<tr class="memdesc:a208402e837b0663e6f2a4babbc555145"><td class="mdescLeft"> </td><td class="mdescRight">Opens an existing named event object. <a href="classwinstd_1_1event.html#a208402e837b0663e6f2a4babbc555145">More...</a><br /></td></tr>
|
|
<tr class="separator:a208402e837b0663e6f2a4babbc555145"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classwinstd_1_1win__handle"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classwinstd_1_1win__handle')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classwinstd_1_1win__handle.html">winstd::win_handle< NULL ></a></td></tr>
|
|
<tr class="memitem:a6b8070a3be4dede99a1c764b7f341a36 inherit pub_methods_classwinstd_1_1win__handle"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1win__handle.html#a6b8070a3be4dede99a1c764b7f341a36">~win_handle</a> ()</td></tr>
|
|
<tr class="memdesc:a6b8070a3be4dede99a1c764b7f341a36 inherit pub_methods_classwinstd_1_1win__handle"><td class="mdescLeft"> </td><td class="mdescRight">Closes an open object handle. <a href="classwinstd_1_1win__handle.html#a6b8070a3be4dede99a1c764b7f341a36">More...</a><br /></td></tr>
|
|
<tr class="separator:a6b8070a3be4dede99a1c764b7f341a36 inherit pub_methods_classwinstd_1_1win__handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classwinstd_1_1handle"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classwinstd_1_1handle')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classwinstd_1_1handle.html">winstd::handle< HANDLE, INVALID ></a></td></tr>
|
|
<tr class="memitem:a1b9c4f9529c9efa7d16dec8bab3b00e4 inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top"><a id="a1b9c4f9529c9efa7d16dec8bab3b00e4" name="a1b9c4f9529c9efa7d16dec8bab3b00e4"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>handle</b> () noexcept</td></tr>
|
|
<tr class="memdesc:a1b9c4f9529c9efa7d16dec8bab3b00e4 inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Initializes a new class instance with the object handle set to INVAL. <br /></td></tr>
|
|
<tr class="separator:a1b9c4f9529c9efa7d16dec8bab3b00e4 inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4a0f9b6caadf4a55c7bc0dcc0ce39dac inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a4a0f9b6caadf4a55c7bc0dcc0ce39dac">handle</a> (<a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> h) noexcept</td></tr>
|
|
<tr class="memdesc:a4a0f9b6caadf4a55c7bc0dcc0ce39dac inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Initializes a new class instance with an already available object handle. <a href="classwinstd_1_1handle.html#a4a0f9b6caadf4a55c7bc0dcc0ce39dac">More...</a><br /></td></tr>
|
|
<tr class="separator:a4a0f9b6caadf4a55c7bc0dcc0ce39dac inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac52f342530bb97ce1ff255a7054547d5 inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#ac52f342530bb97ce1ff255a7054547d5">handle</a> (<a class="el" href="classwinstd_1_1handle.html">handle</a>< <a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a>, INVAL > &&h) noexcept</td></tr>
|
|
<tr class="memdesc:ac52f342530bb97ce1ff255a7054547d5 inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Move constructor. <a href="classwinstd_1_1handle.html#ac52f342530bb97ce1ff255a7054547d5">More...</a><br /></td></tr>
|
|
<tr class="separator:ac52f342530bb97ce1ff255a7054547d5 inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a591e006af92e4d088fb9c1ed974c0923 inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwinstd_1_1handle.html">handle</a>< <a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a>, INVAL > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a591e006af92e4d088fb9c1ed974c0923">operator=</a> (<a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> h) noexcept</td></tr>
|
|
<tr class="memdesc:a591e006af92e4d088fb9c1ed974c0923 inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Attaches already available object handle. <a href="classwinstd_1_1handle.html#a591e006af92e4d088fb9c1ed974c0923">More...</a><br /></td></tr>
|
|
<tr class="separator:a591e006af92e4d088fb9c1ed974c0923 inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6326bbc54ec3441e41f30bc1ec4d6a6c inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwinstd_1_1handle.html">handle</a>< <a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a>, INVAL > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a6326bbc54ec3441e41f30bc1ec4d6a6c">operator=</a> (<a class="el" href="classwinstd_1_1handle.html">handle</a>< <a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a>, INVAL > &&h) noexcept</td></tr>
|
|
<tr class="memdesc:a6326bbc54ec3441e41f30bc1ec4d6a6c inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Move assignment. <a href="classwinstd_1_1handle.html#a6326bbc54ec3441e41f30bc1ec4d6a6c">More...</a><br /></td></tr>
|
|
<tr class="separator:a6326bbc54ec3441e41f30bc1ec4d6a6c inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a86114637674c82d6fd96d7b3eae39ac8 inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a86114637674c82d6fd96d7b3eae39ac8">operator handle_type</a> () const</td></tr>
|
|
<tr class="memdesc:a86114637674c82d6fd96d7b3eae39ac8 inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Auto-typecasting operator. <a href="classwinstd_1_1handle.html#a86114637674c82d6fd96d7b3eae39ac8">More...</a><br /></td></tr>
|
|
<tr class="separator:a86114637674c82d6fd96d7b3eae39ac8 inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0f1ac60cf62e41c24394bf0e3457fbd9 inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> *& </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a0f1ac60cf62e41c24394bf0e3457fbd9">operator*</a> () const</td></tr>
|
|
<tr class="memdesc:a0f1ac60cf62e41c24394bf0e3457fbd9 inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Returns the object handle value when the object handle is a pointer to a value (class, struct, etc.). <a href="classwinstd_1_1handle.html#a0f1ac60cf62e41c24394bf0e3457fbd9">More...</a><br /></td></tr>
|
|
<tr class="separator:a0f1ac60cf62e41c24394bf0e3457fbd9 inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2bd2de7bb89dcebe2c9379dd54ee79c1 inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a2bd2de7bb89dcebe2c9379dd54ee79c1">operator&</a> ()</td></tr>
|
|
<tr class="memdesc:a2bd2de7bb89dcebe2c9379dd54ee79c1 inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Returns the object handle reference. <a href="classwinstd_1_1handle.html#a2bd2de7bb89dcebe2c9379dd54ee79c1">More...</a><br /></td></tr>
|
|
<tr class="separator:a2bd2de7bb89dcebe2c9379dd54ee79c1 inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a285ada5936fe7afdd12eed70b38c2084 inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a285ada5936fe7afdd12eed70b38c2084">operator-></a> () const</td></tr>
|
|
<tr class="memdesc:a285ada5936fe7afdd12eed70b38c2084 inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Provides object handle member access when the object handle is a pointer to a class or struct. <a href="classwinstd_1_1handle.html#a285ada5936fe7afdd12eed70b38c2084">More...</a><br /></td></tr>
|
|
<tr class="separator:a285ada5936fe7afdd12eed70b38c2084 inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5df08ecb32b9040bf7342479aee2286c inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a5df08ecb32b9040bf7342479aee2286c">operator!</a> () const</td></tr>
|
|
<tr class="memdesc:a5df08ecb32b9040bf7342479aee2286c inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Tests if the object handle is INVAL. <a href="classwinstd_1_1handle.html#a5df08ecb32b9040bf7342479aee2286c">More...</a><br /></td></tr>
|
|
<tr class="separator:a5df08ecb32b9040bf7342479aee2286c inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4c4515d0d1071cab5c675e926aa2dc92 inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a4c4515d0d1071cab5c675e926aa2dc92">operator<</a> (<a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> h) const</td></tr>
|
|
<tr class="memdesc:a4c4515d0d1071cab5c675e926aa2dc92 inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Is handle less than? <a href="classwinstd_1_1handle.html#a4c4515d0d1071cab5c675e926aa2dc92">More...</a><br /></td></tr>
|
|
<tr class="separator:a4c4515d0d1071cab5c675e926aa2dc92 inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af9e9538d58b952799db4a1c68b0184b9 inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#af9e9538d58b952799db4a1c68b0184b9">operator<=</a> (<a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> h) const</td></tr>
|
|
<tr class="memdesc:af9e9538d58b952799db4a1c68b0184b9 inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Is handle less than or equal to? <a href="classwinstd_1_1handle.html#af9e9538d58b952799db4a1c68b0184b9">More...</a><br /></td></tr>
|
|
<tr class="separator:af9e9538d58b952799db4a1c68b0184b9 inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a20e325dde8a25d1e3a7efb50b431641b inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a20e325dde8a25d1e3a7efb50b431641b">operator>=</a> (<a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> h) const</td></tr>
|
|
<tr class="memdesc:a20e325dde8a25d1e3a7efb50b431641b inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Is handle greater than or equal to? <a href="classwinstd_1_1handle.html#a20e325dde8a25d1e3a7efb50b431641b">More...</a><br /></td></tr>
|
|
<tr class="separator:a20e325dde8a25d1e3a7efb50b431641b inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae7361f6159006e3f87cbe10ba2a76329 inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#ae7361f6159006e3f87cbe10ba2a76329">operator></a> (<a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> h) const</td></tr>
|
|
<tr class="memdesc:ae7361f6159006e3f87cbe10ba2a76329 inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Is handle greater than? <a href="classwinstd_1_1handle.html#ae7361f6159006e3f87cbe10ba2a76329">More...</a><br /></td></tr>
|
|
<tr class="separator:ae7361f6159006e3f87cbe10ba2a76329 inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6df58f6c131ab4288acb96d5b8f3012e inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a6df58f6c131ab4288acb96d5b8f3012e">operator!=</a> (<a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> h) const</td></tr>
|
|
<tr class="memdesc:a6df58f6c131ab4288acb96d5b8f3012e inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Is handle not equal to? <a href="classwinstd_1_1handle.html#a6df58f6c131ab4288acb96d5b8f3012e">More...</a><br /></td></tr>
|
|
<tr class="separator:a6df58f6c131ab4288acb96d5b8f3012e inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab6021e9c11accef6b813948dc4601ddc inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#ab6021e9c11accef6b813948dc4601ddc">operator==</a> (<a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> h) const</td></tr>
|
|
<tr class="memdesc:ab6021e9c11accef6b813948dc4601ddc inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Is handle equal to? <a href="classwinstd_1_1handle.html#ab6021e9c11accef6b813948dc4601ddc">More...</a><br /></td></tr>
|
|
<tr class="separator:ab6021e9c11accef6b813948dc4601ddc inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab2a98042c3b88fda687e34d370756f11 inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#ab2a98042c3b88fda687e34d370756f11">attach</a> (<a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> h) noexcept</td></tr>
|
|
<tr class="memdesc:ab2a98042c3b88fda687e34d370756f11 inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Sets a new object handle for the class. <a href="classwinstd_1_1handle.html#ab2a98042c3b88fda687e34d370756f11">More...</a><br /></td></tr>
|
|
<tr class="separator:ab2a98042c3b88fda687e34d370756f11 inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad5acf6ce53e092b8d4d53f909cf321f9 inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#ad5acf6ce53e092b8d4d53f909cf321f9">detach</a> ()</td></tr>
|
|
<tr class="memdesc:ad5acf6ce53e092b8d4d53f909cf321f9 inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Dismisses the object handle from this class. <a href="classwinstd_1_1handle.html#ad5acf6ce53e092b8d4d53f909cf321f9">More...</a><br /></td></tr>
|
|
<tr class="separator:ad5acf6ce53e092b8d4d53f909cf321f9 inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a706aaab7691a472c608890f8e5dd0d96 inherit pub_methods_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top"><a id="a706aaab7691a472c608890f8e5dd0d96" name="a706aaab7691a472c608890f8e5dd0d96"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>free</b> ()</td></tr>
|
|
<tr class="memdesc:a706aaab7691a472c608890f8e5dd0d96 inherit pub_methods_classwinstd_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Destroys the object. <br /></td></tr>
|
|
<tr class="separator:a706aaab7691a472c608890f8e5dd0d96 inherit pub_methods_classwinstd_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
|
|
Additional Inherited Members</h2></td></tr>
|
|
<tr class="inherit_header pub_types_classwinstd_1_1handle"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classwinstd_1_1handle')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="classwinstd_1_1handle.html">winstd::handle< HANDLE, INVALID ></a></td></tr>
|
|
<tr class="memitem:a3dda19199ecfbc378c932e7d84d0ea81 inherit pub_types_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top"><a id="a3dda19199ecfbc378c932e7d84d0ea81" name="a3dda19199ecfbc378c932e7d84d0ea81"></a>
|
|
typedef HANDLE </td><td class="memItemRight" valign="bottom"><b>handle_type</b></td></tr>
|
|
<tr class="memdesc:a3dda19199ecfbc378c932e7d84d0ea81 inherit pub_types_classwinstd_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Datatype of the object handle this template class handles. <br /></td></tr>
|
|
<tr class="separator:a3dda19199ecfbc378c932e7d84d0ea81 inherit pub_types_classwinstd_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_static_attribs_classwinstd_1_1handle"><td colspan="2" onclick="javascript:toggleInherit('pub_static_attribs_classwinstd_1_1handle')"><img src="closed.png" alt="-"/> Static Public Attributes inherited from <a class="el" href="classwinstd_1_1handle.html">winstd::handle< HANDLE, INVALID ></a></td></tr>
|
|
<tr class="memitem:gacf43e306968474166474090690857e1c inherit pub_static_attribs_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top"><a id="gacf43e306968474166474090690857e1c" name="gacf43e306968474166474090690857e1c"></a>
|
|
static const HANDLE </td><td class="memItemRight" valign="bottom"><b>invalid</b></td></tr>
|
|
<tr class="memdesc:gacf43e306968474166474090690857e1c inherit pub_static_attribs_classwinstd_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Invalid handle value. <br /></td></tr>
|
|
<tr class="separator:gacf43e306968474166474090690857e1c inherit pub_static_attribs_classwinstd_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pro_methods_classwinstd_1_1win__handle"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classwinstd_1_1win__handle')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classwinstd_1_1win__handle.html">winstd::win_handle< NULL ></a></td></tr>
|
|
<tr class="memitem:a456fe19828113913f42e901f112c6455 inherit pro_methods_classwinstd_1_1win__handle"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1win__handle.html#a456fe19828113913f42e901f112c6455">free_internal</a> () noexcept override</td></tr>
|
|
<tr class="memdesc:a456fe19828113913f42e901f112c6455 inherit pro_methods_classwinstd_1_1win__handle"><td class="mdescLeft"> </td><td class="mdescRight">Closes an open object handle. <a href="classwinstd_1_1win__handle.html#a456fe19828113913f42e901f112c6455">More...</a><br /></td></tr>
|
|
<tr class="separator:a456fe19828113913f42e901f112c6455 inherit pro_methods_classwinstd_1_1win__handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a137560600851eb4c3e4b80e25d4da629"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinstd_1_1handle.html#a137560600851eb4c3e4b80e25d4da629">free_internal</a> () noexcept=0</td></tr>
|
|
<tr class="memdesc:a137560600851eb4c3e4b80e25d4da629"><td class="mdescLeft"> </td><td class="mdescRight">Abstract member function that must be implemented by child classes to do the actual object destruction. <a href="classwinstd_1_1handle.html#a137560600851eb4c3e4b80e25d4da629">More...</a><br /></td></tr>
|
|
<tr class="separator:a137560600851eb4c3e4b80e25d4da629"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pro_attribs_classwinstd_1_1handle"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classwinstd_1_1handle')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classwinstd_1_1handle.html">winstd::handle< HANDLE, INVALID ></a></td></tr>
|
|
<tr class="memitem:aabde3f16fd98b06b3b0282ef7806eb59 inherit pro_attribs_classwinstd_1_1handle"><td class="memItemLeft" align="right" valign="top"><a id="aabde3f16fd98b06b3b0282ef7806eb59" name="aabde3f16fd98b06b3b0282ef7806eb59"></a>
|
|
<a class="el" href="classwinstd_1_1handle.html#a3dda19199ecfbc378c932e7d84d0ea81">handle_type</a> </td><td class="memItemRight" valign="bottom"><b>m_h</b></td></tr>
|
|
<tr class="memdesc:aabde3f16fd98b06b3b0282ef7806eb59 inherit pro_attribs_classwinstd_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Object handle. <br /></td></tr>
|
|
<tr class="separator:aabde3f16fd98b06b3b0282ef7806eb59 inherit pro_attribs_classwinstd_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p >Event handle wrapper. </p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a97d7be96a11e0b5232db73e7cb5d1395" name="a97d7be96a11e0b5232db73e7cb5d1395"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a97d7be96a11e0b5232db73e7cb5d1395">◆ </a></span>create()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool winstd::event::create </td>
|
|
<td>(</td>
|
|
<td class="paramtype">BOOL </td>
|
|
<td class="paramname"><em>bManualReset</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">BOOL </td>
|
|
<td class="paramname"><em>bInitialState</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">LPSECURITY_ATTRIBUTES </td>
|
|
<td class="paramname"><em>lpEventAttributes</em> = <code>NULL</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">LPCTSTR </td>
|
|
<td class="paramname"><em>lpName</em> = <code>NULL</code> </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>Creates or opens a named or unnamed event object. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a href="https://docs.microsoft.com/en-us/windows/desktop/api/synchapi/nf-synchapi-createeventw">CreateEventW function</a></dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><ul>
|
|
<li><code>true</code> when succeeds;</li>
|
|
<li><code>false</code> when fails. Use <code>GetLastError()</code> for failure reason. </li>
|
|
</ul>
|
|
</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a208402e837b0663e6f2a4babbc555145" name="a208402e837b0663e6f2a4babbc555145"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a208402e837b0663e6f2a4babbc555145">◆ </a></span>open()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool winstd::event::open </td>
|
|
<td>(</td>
|
|
<td class="paramtype">DWORD </td>
|
|
<td class="paramname"><em>dwDesiredAccess</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">BOOL </td>
|
|
<td class="paramname"><em>bInheritHandle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">LPCTSTR </td>
|
|
<td class="paramname"><em>lpName</em> </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>Opens an existing named event object. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a href="https://docs.microsoft.com/en-us/windows/desktop/api/synchapi/nf-synchapi-openeventw">OpenEventW function</a></dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><ul>
|
|
<li><code>true</code> when succeeds;</li>
|
|
<li><code>false</code> when fails. Use <code>GetLastError()</code> for failure reason. </li>
|
|
</ul>
|
|
</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>include/WinStd/<a class="el" href="_win_8h_source.html">Win.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Wed Feb 9 2022 11:05:13 for WinStd by <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>
|