241 lines
11 KiB
HTML
241 lines
11 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.13.2"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Base Module: FDeleter< T > Struct Template 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>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="resize.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" />
|
|
<link href="smtg_extra.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">Base Module<span id="projectnumber"> VST 3.8</span>
|
|
</div>
|
|
<div id="projectbrief">SDK for developing VST plug-in</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.13.2 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @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',true);
|
|
$(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function(){initNavTree('structSteinberg_1_1FDeleter.html',''); initResizable(true); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- 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 class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="structSteinberg_1_1FDeleter-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">FDeleter< T > Struct Template Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Template definition for classes that help guarding against memory leaks.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <fcleanup.h></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:a8d904032d15002f7232451f551053c29" id="r_a8d904032d15002f7232451f551053c29"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8d904032d15002f7232451f551053c29">FDeleter</a> (T *_toDelete)</td></tr>
|
|
<tr class="memdesc:a8d904032d15002f7232451f551053c29"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br /></td></tr>
|
|
<tr class="separator:a8d904032d15002f7232451f551053c29"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af7025fb8b71b21b2b945a99a326aae46" id="r_af7025fb8b71b21b2b945a99a326aae46"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#af7025fb8b71b21b2b945a99a326aae46">~FDeleter</a> ()</td></tr>
|
|
<tr class="memdesc:af7025fb8b71b21b2b945a99a326aae46"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. Calls delete on the at construction time passed pointer. <br /></td></tr>
|
|
<tr class="separator:af7025fb8b71b21b2b945a99a326aae46"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr class="memitem:a96acfe8f38200ad7c85bff6c9032fc95" id="r_a96acfe8f38200ad7c85bff6c9032fc95"><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="#a96acfe8f38200ad7c85bff6c9032fc95">toDelete</a></td></tr>
|
|
<tr class="memdesc:a96acfe8f38200ad7c85bff6c9032fc95"><td class="mdescLeft"> </td><td class="mdescRight">Remembers the object that is to be deleted during destruction. <br /></td></tr>
|
|
<tr class="separator:a96acfe8f38200ad7c85bff6c9032fc95"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><div class="compoundTemplParams">template<class T><br />
|
|
struct Steinberg::FDeleter< T ></div><p>Template definition for classes that help guarding against memory leaks. </p>
|
|
<p>A stack allocated object of this type automatically deletes an at construction time passed dynamically allocated single object when it reaches the end of its scope. <br />
|
|
<br />
|
|
Intended usage: </p><div class="fragment"><div class="line">{</div>
|
|
<div class="line"> <span class="keywordtype">int</span>* pointerToInt = <span class="keyword">new</span> int;</div>
|
|
<div class="line"> <a class="code hl_struct" href="structSteinberg_1_1FDeleter.html">Steinberg::FDeleter<int></a> deleter (pointerToInt);</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="comment">// Do something with the variable behind pointerToInt.</span></div>
|
|
<div class="line"> </div>
|
|
<div class="line">} <span class="comment">// No memory leak here, destructor of deleter cleans up the integer.</span></div>
|
|
<div class="ttc" id="astructSteinberg_1_1FDeleter_html"><div class="ttname"><a href="structSteinberg_1_1FDeleter.html">Steinberg::FDeleter</a></div><div class="ttdoc">Template definition for classes that help guarding against memory leaks.</div><div class="ttdef"><b>Definition</b> fcleanup.h:41</div></div>
|
|
</div><!-- fragment --> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a8d904032d15002f7232451f551053c29" name="a8d904032d15002f7232451f551053c29"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8d904032d15002f7232451f551053c29">◆ </a></span>FDeleter()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structSteinberg_1_1FDeleter.html">FDeleter</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">T *</td> <td class="paramname"><span class="paramname"><em>_toDelete</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constructor. </p>
|
|
<p>_toDelete is a pointer to the dynamically allocated object that is to be deleted when this <a class="el" href="structSteinberg_1_1FDeleter.html" title="Template definition for classes that help guarding against memory leaks.">FDeleter</a> object's destructor is executed. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af7025fb8b71b21b2b945a99a326aae46" name="af7025fb8b71b21b2b945a99a326aae46"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af7025fb8b71b21b2b945a99a326aae46">◆ </a></span>~FDeleter()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">~<a class="el" href="structSteinberg_1_1FDeleter.html">FDeleter</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Destructor. Calls delete on the at construction time passed pointer. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="a96acfe8f38200ad7c85bff6c9032fc95" name="a96acfe8f38200ad7c85bff6c9032fc95"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a96acfe8f38200ad7c85bff6c9032fc95">◆ </a></span>toDelete</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">T* toDelete</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Remembers the object that is to be deleted during destruction. </p>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<html>
|
|
<head>
|
|
<title>Empty</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
<meta name="Author" content="Steinberg">
|
|
</head>
|
|
<body>
|
|
<br/>
|
|
<hr width="100%" size="2" align="left" />
|
|
<div align=right>
|
|
Copyright ©<span id="year"></span> <a href="http://www.steinberg.net" target="_blank"><u>Steinberg Media Technologies GmbH</u></a>.
|
|
All Rights Reserved. This documentation is under this <a href="http://www.steinberg.net/sdklicenses" target="_blank"><u>license</u></a>.
|
|
</div>
|
|
<script>
|
|
document.querySelector("#year").textContent = new Date().getFullYear();
|
|
</script>
|
|
</body>
|
|
</html>
|