nephele
/
haiku-website
0
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
haiku-website/static/legacy-docs/bebook/TheStorageKit_Constants.html

55 lines
11 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>The Be Book - Classes And Methods - The Storage Kit</title><link rel="stylesheet" href="be_book.css" type="text/css" media="all" /><link rel="shortcut icon" type="image/vnd.microsoft.icon" href="./images/favicon.ico" /><!--[if IE]>
<link rel="stylesheet" type="text/css" href="be_book_ie.css" />
<![endif]--><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /><meta name="keywords" content="Access, BeOS, BeBook, API" /><link rel="start" href="index.html" title="The Be Book" /><link rel="up" href="TheStorageKit.html" title="The Storage Kit" /><link rel="prev" href="TheStorageKit_Functions.html" title="Functions" /><link rel="next" href="TheStorageKit_MessageConstants.html" title="Message Constants" /></head><body><div id="header"><div id="headerT"><div id="headerTL"><a accesskey="p" href="TheStorageKit_Functions.html" title="Functions"><img src="./images/navigation/prev.png" alt="Prev" /></a> <a accesskey="u" href="TheStorageKit.html" title="The Storage Kit"><img src="./images/navigation/up.png" alt="Up" /></a> <a accesskey="n" href="TheStorageKit_MessageConstants.html" title="Message Constants"><img src="./images/navigation/next.png" alt="Next" /></a></div><div id="headerTR"><div id="navigpeople"><a href="http://www.haiku-os.org"><img src="./images/People_24.png" alt="haiku-os.org" title="Visit The Haiku Website" /></a></div><div class="navighome" title="Home"><a accesskey="h" href="index.html"><img src="./images/navigation/home.png" alt="Home" /></a></div><div class="navigboxed" id="navigindex"><a accesskey="i" href="ClassIndex.html" title="Index">I</a></div><div class="navigboxed" id="naviglang" title="English">en</div></div><div id="headerTC">The Be Book - Classes And Methods - The Storage Kit</div></div><div id="headerB">Prev: <a href="TheStorageKit_Functions.html">Functions</a>  Up: <a href="TheStorageKit.html">The Storage Kit</a>  Next: <a href="TheStorageKit_MessageConstants.html">Message Constants</a></div><hr /></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h2 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="TheStorageKit_Constants"></a>Constants</h2></div></div></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><hr /><div xmlns:d="http://docbook.org/ns/docbook"><h3 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="Constants_Limits"></a><a id="B_FILE_NAME_LENGTH"></a>
<a id="B_PATH_NAME_LENGTH"></a>
<a id="B_ATTR_NAME_LENGTH"></a>
<a id="B_MIME_TYPE_LENGTH"></a>
<a id="B_MAX_SYMLINKS"></a>
Limits Constants</h3></div></div></div><a id="id1265137" class="indexterm"></a><a id="id1265147" class="indexterm"></a><a id="id1265156" class="indexterm"></a><a id="id1265166" class="indexterm"></a><a id="id1265176" class="indexterm"></a><p>
Declared in: <code class="filename">storage/StorageDefs.h</code>
</p><table class="variablelist constants"><thead><tr><th>Constant</th><th>Description</th></tr></thead><tbody><tr><td><p><span class="term"><code class="constant">B_FILE_NAME_LENGTH</code></span></p></td><td><p>Number of characters allowed in a file name.</p></td></tr><tr><td><p><span class="term"><code class="constant">B_PATH_NAME_LENGTH</code></span></p></td><td><p>Number of characters allowed in a path name.</p></td></tr><tr><td><p><span class="term"><code class="constant">B_ATTR_NAME_LENGTH</code></span></p></td><td><p>Number of characters allowed in an attribute name.</p></td></tr><tr><td><p><span class="term"><code class="constant">B_MIME_TYPE_LENGTH</code></span></p></td><td><p>Number of characters allowed in a MIME type name.</p></td></tr><tr><td><p><span class="term"><code class="constant">B_MAX_SYMLINKS</code></span></p></td><td><p>Number of nested symlinks allowed.</p></td></tr></tbody></table><p>
These constants define the maximum values for several Storage Kit related
items, including file and path name strings, attribute name strings, and
MIME type strings. <code class="constant">B_MAX_SYMLINKS</code> specifies how many symbolic links may
be linked through each other.
</p></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><hr /><div xmlns:d="http://docbook.org/ns/docbook"><h3 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="Constants_File_Open_Mode"></a><a id="B_READ_ONLY"></a>
<a id="B_WRITE_ONLY"></a>
<a id="B_READ_WRITE"></a>
<a id="B_FAIL_IF_EXISTS"></a>
<a id="B_CREATE_FILE"></a>
<a id="B_ERASE_FILE"></a>
<a id="B_OPEN_AT_END"></a>
File Open Mode Constants</h3></div></div></div><a id="id1265339" class="indexterm"></a><a id="id1265348" class="indexterm"></a><a id="id1265357" class="indexterm"></a><a id="id1265366" class="indexterm"></a><a id="id1265375" class="indexterm"></a><a id="id1265384" class="indexterm"></a><a id="id1265393" class="indexterm"></a><p>
Declared in: <code class="filename">storage/StorageDefs.h</code>
</p><table class="variablelist constants"><thead><tr><th>Constant</th><th>Description</th></tr></thead><tbody><tr><td><p><span class="term"><code class="constant">B_READ_ONLY</code></span></p></td><td><p>Open the file with read-only access.</p></td></tr><tr><td><p><span class="term"><code class="constant">B_WRITE_ONLY</code></span></p></td><td><p>Open the file with write-only access.</p></td></tr><tr><td><p><span class="term"><code class="constant">B_READ_WRITE</code></span></p></td><td><p>Open the file for both reading and writing.</p></td></tr><tr><td><p><span class="term"><code class="constant">B_FAIL_IF_EXISTS</code></span></p></td><td><p>Don't open the file if it already exists.</p></td></tr><tr><td><p><span class="term"><code class="constant">B_CREATE_FILE</code></span></p></td><td><p>Create the file before opening it.</p></td></tr><tr><td><p><span class="term"><code class="constant">B_ERASE_FILE</code></span></p></td><td><p>Erase the previous contents before opening the file.</p></td></tr><tr><td><p><span class="term"><code class="constant">B_OPEN_AT_END</code></span></p></td><td><p>Open with the pointer at the end of the file.</p></td></tr></tbody></table><p>
These constants are used when opening files using either the POSIX <code class="function">open()</code>
function or using the
<a class="link" href="BFile.html" title="BFile"><code class="classname">BFile</code></a> class. They specify the mode in which the
file is to be opened. For instance, if write-only access is desired, and
you want the operation to fail if the file exists, you would do the
following:
</p><pre class="programlisting example c"><code class="varname">fd</code> = <code class="function">open</code>("foobar.data", <code class="constant">B_WRITE_ONLY</code> | <code class="constant">B_FAIL_IF_EXISTS</code>);</pre></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><hr /><div xmlns:d="http://docbook.org/ns/docbook"><h3 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="Constants_Node_Flavors"></a><a id="B_FILE_NODE"></a>
<a id="B_SYMLINK_NODE"></a>
<a id="B_DIRECTORY_NODE"></a>
<a id="B_ANY_NODE"></a>
Node Flavors</h3></div></div></div><a id="id1265605" class="indexterm"></a><a id="id1265614" class="indexterm"></a><a id="id1265623" class="indexterm"></a><a id="id1265632" class="indexterm"></a><p>
Declared in: <code class="filename">storage/StorageDefs.h</code>
</p><table class="variablelist constants"><thead><tr><th>Constant</th><th>Description</th></tr></thead><tbody><tr><td><p><span class="term"><code class="constant">B_FILE_NODE</code></span></p></td><td><p>Files only.</p></td></tr><tr><td><p><span class="term"><code class="constant">B_SYMLINK_NODE</code></span></p></td><td><p>Symbolic links only.</p></td></tr><tr><td><p><span class="term"><code class="constant">B_DIRECTORY_NODE</code></span></p></td><td><p>Directories only.</p></td></tr><tr><td><p><span class="term"><code class="constant">B_ANY_NODE</code></span></p></td><td><p>Matches any node.</p></td></tr></tbody></table><p>
These constants are used when making a request that can be qualified
based on the "flavor" of a node—in other words, whenever you wish
to perform an operation on only files, directories, or symbolic links.
This is used when opening a file panel, for instance, so that you can
specify what types of items you want the user to be able to select.
</p></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><hr /><div xmlns:d="http://docbook.org/ns/docbook"><h3 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="Constants_Icon_Sizes"></a><a id="B_LARGE_ICON"></a>
<a id="B_MINI_ICON"></a>
Icon Sizes</h3></div></div></div><a id="id1265751" class="indexterm"></a><a id="id1265760" class="indexterm"></a><p>
Declared in: <code class="filename">storage/Mime.h</code>
</p><table class="variablelist constants"><thead><tr><th>Constant</th><th>Description</th></tr></thead><tbody><tr><td><p><span class="term"><code class="constant">B_LARGE_ICON</code></span></p></td><td><p>Large (32x32) icon.</p></td></tr><tr><td><p><span class="term"><code class="constant">B_MINI_ICON</code></span></p></td><td><p>Small (16x16) icon.</p></td></tr></tbody></table><p>
These constants are used when selecting icons from a meta MIME file; they
let you fetch the large and small variations of a file's icon.
</p></div></div><div id="footer"><hr /><div id="footerT">Prev: <a href="TheStorageKit_Functions.html">Functions</a>  Up: <a href="TheStorageKit.html">The Storage Kit</a>  Next: <a href="TheStorageKit_MessageConstants.html">Message Constants</a> </div><div id="footerB"><div id="footerBL"><a href="TheStorageKit_Functions.html" title="Functions"><img src="./images/navigation/prev.png" alt="Prev" /></a> <a href="TheStorageKit.html" title="The Storage Kit"><img src="./images/navigation/up.png" alt="Up" /></a> <a href="TheStorageKit_MessageConstants.html" title="Message Constants"><img src="./images/navigation/next.png" alt="Next" /></a></div><div id="footerBR"><div><a href="http://www.haiku-os.org"><img src="./images/People_24.png" alt="haiku-os.org" title="Visit The Haiku Website" /></a></div><div class="navighome" title="Home"><a accesskey="h" href="index.html"><img src="./images/navigation/home.png" alt="Home" /></a></div></div><div id="footerBC"><a href="http://www.access-company.com/home.html" title="ACCESS Co."><img alt="Access Company" src="./images/access_logo.png" /></a></div></div></div><div id="licenseFooter"><div id="licenseFooterBL"><a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/3.0/" title="Creative Commons License"><img alt="Creative Commons License" style="border-width:0" src="https://licensebuttons.net/l/by-nc-nd/3.0/88x31.png" /></a></div><div id="licenseFooterBR"><a href="./LegalNotice.html">Legal Notice</a></div><div id="licenseFooterBC"><span id="licenseText">This work is licensed under a
<a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/3.0/">Creative
Commons Attribution-Non commercial-No Derivative Works 3.0 License</a>.</span></div></div></body></html>
Reference in New Issue View Git Blame Copy Permalink