Imported Upstream version 1.64.0
[platform/upstream/boost.git] / doc / html / boost / interprocess / xsi_key.html
index 4f7e0c2..cf7172a 100644 (file)
 <span class="keyword">class</span> <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> <span class="special">{</span>
 <span class="keyword">public</span><span class="special">:</span>
   <span class="comment">// <a class="link" href="xsi_key.html#boost.interprocess.xsi_keyconstruct-copy-destruct">construct/copy/destruct</a></span>
-  <a class="link" href="xsi_key.html#idp48780448-bb"><span class="identifier">xsi_key</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
-  <span class="keyword">explicit</span> <a class="link" href="xsi_key.html#idp48781920-bb"><span class="identifier">xsi_key</span></a><span class="special">(</span><span class="identifier">key_t</span><span class="special">)</span><span class="special">;</span>
-  <a class="link" href="xsi_key.html#idp48783536-bb"><span class="identifier">xsi_key</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">uint8_t</span><span class="special">)</span><span class="special">;</span>
+  <a class="link" href="xsi_key.html#idp45967136-bb"><span class="identifier">xsi_key</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+  <span class="keyword">explicit</span> <a class="link" href="xsi_key.html#idp45968608-bb"><span class="identifier">xsi_key</span></a><span class="special">(</span><span class="identifier">key_t</span><span class="special">)</span><span class="special">;</span>
+  <a class="link" href="xsi_key.html#idp45970224-bb"><span class="identifier">xsi_key</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">uint8_t</span><span class="special">)</span><span class="special">;</span>
 
-  <span class="comment">// <a class="link" href="xsi_key.html#idp48778304-bb">public member functions</a></span>
-  <span class="identifier">key_t</span> <a class="link" href="xsi_key.html#idp48778864-bb"><span class="identifier">get_key</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+  <span class="comment">// <a class="link" href="xsi_key.html#idp45964992-bb">public member functions</a></span>
+  <span class="identifier">key_t</span> <a class="link" href="xsi_key.html#idp45965552-bb"><span class="identifier">get_key</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
 <span class="special">}</span><span class="special">;</span></pre></div>
 <div class="refsect1">
-<a name="idp388514288"></a><h2>Description</h2>
+<a name="idp293085696"></a><h2>Description</h2>
 <p>A class that wraps XSI (System V) key_t type. This type calculates key_t from path and id using ftok, sets key to a specified value, or sets key to IPC_PRIVATE using the default constructor. </p>
 <div class="refsect2">
-<a name="idp388515168"></a><h3>
+<a name="idp293086576"></a><h3>
 <a name="boost.interprocess.xsi_keyconstruct-copy-destruct"></a><code class="computeroutput">xsi_key</code> 
         public
        construct/copy/destruct</h3>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem">
-<pre class="literallayout"><a name="idp48780448-bb"></a><span class="identifier">xsi_key</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><a name="idp45967136-bb"></a><span class="identifier">xsi_key</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 <p>Default constructor. Represents a private <code class="computeroutput"><a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a></code>. </p>
 </li>
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp48781920-bb"></a><span class="identifier">xsi_key</span><span class="special">(</span><span class="identifier">key_t</span> key<span class="special">)</span><span class="special">;</span></pre>Creates a new XSI key using a specified value. Constructor is explicit to avoid ambiguity with shmid. </li>
+<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp45968608-bb"></a><span class="identifier">xsi_key</span><span class="special">(</span><span class="identifier">key_t</span> key<span class="special">)</span><span class="special">;</span></pre>Creates a new XSI key using a specified value. Constructor is explicit to avoid ambiguity with shmid. </li>
 <li class="listitem">
-<pre class="literallayout"><a name="idp48783536-bb"></a><span class="identifier">xsi_key</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> path<span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">uint8_t</span> id<span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><a name="idp45970224-bb"></a><span class="identifier">xsi_key</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> path<span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">uint8_t</span> id<span class="special">)</span><span class="special">;</span></pre>
 <p>Creates a new XSI shared memory with a key obtained from a call to ftok (with path "path" and id "id"), of size "size" and permissions "perm". If the shared memory previously exists, throws an error. </p>
 </li>
 </ol></div>
 </div>
 <div class="refsect2">
-<a name="idp388536464"></a><h3>
-<a name="idp48778304-bb"></a><code class="computeroutput">xsi_key</code> public member functions</h3>
+<a name="idp293107808"></a><h3>
+<a name="idp45964992-bb"></a><code class="computeroutput">xsi_key</code> public member functions</h3>
 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
-<pre class="literallayout"><span class="identifier">key_t</span> <a name="idp48778864-bb"></a><span class="identifier">get_key</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the internal key_t value. </li></ol></div>
+<pre class="literallayout"><span class="identifier">key_t</span> <a name="idp45965552-bb"></a><span class="identifier">get_key</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the internal key_t value. </li></ol></div>
 </div>
 </div>
 </div>