blob: 5954a83a6b5391f030f7b63728ca79921f388db6 [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class permissions</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
<link rel="up" href="../../boost_interprocess_reference.html#header.boost.interprocess.permissions_hpp" title="Header &lt;boost/interprocess/permissions.hpp&gt;">
<link rel="prev" href="swap_id821801.html" title="Function template swap">
<link rel="next" href="segment_manager_base.html" title="Class template segment_manager_base">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="swap_id821801.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_interprocess_reference.html#header.boost.interprocess.permissions_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="segment_manager_base.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="boost.interprocess.permissions"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class permissions</span></h2>
<p>boost::interprocess::permissions</p>
</div>
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../boost_interprocess_reference.html#header.boost.interprocess.permissions_hpp" title="Header &lt;boost/interprocess/permissions.hpp&gt;">boost/interprocess/permissions.hpp</a>&gt;
</span>
<span class="keyword">class</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
<span class="comment">// <a class="link" href="permissions.html#boost.interprocess.permissionsconstruct-copy-destruct">construct/copy/destruct</a></span>
<a class="link" href="permissions.html#id822047-bb"><span class="identifier">permissions</span></a><span class="special">(</span><span class="identifier">os_permissions_type</span><span class="special">)</span><span class="special">;</span>
<a class="link" href="permissions.html#id822058-bb"><span class="identifier">permissions</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="comment">// <a class="link" href="permissions.html#id821988-bb">public member functions</a></span>
<span class="keyword">void</span> <a class="link" href="permissions.html#id821991-bb"><span class="identifier">set_default</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">void</span> <a class="link" href="permissions.html#id822004-bb"><span class="identifier">set_unrestricted</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">void</span> <a class="link" href="permissions.html#id822017-bb"><span class="identifier">set_permissions</span></a><span class="special">(</span><span class="identifier">os_permissions_type</span><span class="special">)</span><span class="special">;</span>
<span class="identifier">os_permissions_type</span> <a class="link" href="permissions.html#id822035-bb"><span class="identifier">get_permissions</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="id1488315"></a><h2>Description</h2>
<p>The permissions class represents permissions to be set to shared memory or files, that can be constructed form usual permission representations: a SECURITY_ATTRIBUTES pointer in windows or ORed rwx chmod integer in UNIX. </p>
<div class="refsect2">
<a name="id1488324"></a><h3>
<a name="boost.interprocess.permissionsconstruct-copy-destruct"></a><code class="computeroutput">permissions</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><a name="id822047-bb"></a><span class="identifier">permissions</span><span class="special">(</span><span class="identifier">os_permissions_type</span> type<span class="special">)</span><span class="special">;</span></pre>
<p>Constructs a permissions object from a user provided os-dependent permissions. </p>
</li>
<li class="listitem">
<pre class="literallayout"><a name="id822058-bb"></a><span class="identifier">permissions</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Constructs a default permissions object: A null security attributes pointer for windows or 0644 for UNIX. </p>
</li>
</ol></div>
</div>
<div class="refsect2">
<a name="id1488417"></a><h3>
<a name="id821988-bb"></a><code class="computeroutput">permissions</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="id821991-bb"></a><span class="identifier">set_default</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Sets permissions to default values: A null security attributes pointer for windows or 0644 for UNIX. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="id822004-bb"></a><span class="identifier">set_unrestricted</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Sets permissions to unrestricted access: A null DACL for windows or 0666 for UNIX. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="id822017-bb"></a><span class="identifier">set_permissions</span><span class="special">(</span><span class="identifier">os_permissions_type</span> perm<span class="special">)</span><span class="special">;</span></pre>
<p>Sets permissions from a user provided os-dependent permissions. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">os_permissions_type</span> <a name="id822035-bb"></a><span class="identifier">get_permissions</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Returns stored os-dependent permissions </p>
</li>
</ol></div>
</div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2005 - 2010 Ion Gaztanaga<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="swap_id821801.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_interprocess_reference.html#header.boost.interprocess.permissions_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="segment_manager_base.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>