138 lines
13 KiB
HTML
138 lines
13 KiB
HTML
<?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 Support 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="TheSupportKit.html" title="The Support Kit" /><link rel="prev" href="TheSupportKit_Error_Codes.html" title="Error Codes" /><link rel="next" href="TheSupportKit_TLS.html" title="Thread Local Storage" /></head><body><div id="header"><div id="headerT"><div id="headerTL"><a accesskey="p" href="TheSupportKit_Error_Codes.html" title="Error Codes"><img src="./images/navigation/prev.png" alt="Prev" /></a> <a accesskey="u" href="TheSupportKit.html" title="The Support Kit"><img src="./images/navigation/up.png" alt="Up" /></a> <a accesskey="n" href="TheSupportKit_TLS.html" title="Thread Local Storage"><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 Support Kit</div></div><div id="headerB">Prev: <a href="TheSupportKit_Error_Codes.html">Error Codes</a> Up: <a href="TheSupportKit.html">The Support Kit</a> Next: <a href="TheSupportKit_TLS.html">Thread Local Storage</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="TheSupportKit_CDT"></a>Defined Types</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="bigtime_t"></a>bigtime_t</h3></div></div></div><a id="id1289539" class="indexterm"></a><p>
|
||
Declared in: <code class="filename">support/SupportDefs.h</code>
|
||
</p><pre class="programlisting cpp">typedef <span class="type">int64</span> <span class="type">bigtime_t</span></pre><p>
|
||
This type records the time in microseconds as a 64-bit integer.
|
||
Typically, a <span class="type">bigtime_t</span> variable measures the system time, the number of
|
||
microseconds since 12:00:00 AM January 1, 1970, UTC (Coordinated
|
||
Universal Time).
|
||
</p><p>
|
||
See Also:
|
||
<a class="link" href="TheKernelKit_Time.html#system_time" title="system_time()"><code class="function">system_time()</code></a>
|
||
</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="bool"></a>bool</h3></div></div></div><a id="id1289601" class="indexterm"></a><p>
|
||
Declared in: <code class="filename">support/SupportDefs.h</code>
|
||
</p><pre class="programlisting cpp">typedef <span class="type">unsigned char</span> <span class="type">bool</span></pre><p>
|
||
The C++ language defines <span class="type">bool</span> as its basic boolean type. The BeOS extends
|
||
the definition to C code, so you can use the same type in both languages.
|
||
The <code class="constant">true</code> and <code class="constant">false</code> constants (listed above)
|
||
are defined as boolean values.
|
||
</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="Function_Pointers"></a>Function Pointers</h3></div></div></div><a id="id1289660" class="indexterm"></a><a id="id1289667" class="indexterm"></a><a id="id1289674" class="indexterm"></a><p>
|
||
Declared in: <code class="filename">support/SupportDefs.h</code>
|
||
</p><pre class="programlisting cpp">typedef <span class="type">int</span> (*<span class="type">B_PFI</span>)()
|
||
typedef <span class="type">long</span> (*<span class="type">B_PFL</span>)()
|
||
typedef <span class="type">void</span> (*<span class="type">B_PFV</span>)()</pre><p>
|
||
These types define pointers to functions that return <span class="type">int</span>,
|
||
<span class="type">long</span>, and <span class="type">void</span>
|
||
values respectively.
|
||
</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="instantiation_func"></a>instantiation_func</h3></div></div></div><p>
|
||
Declared in: <code class="filename">support/Archivable.h</code>
|
||
</p><pre class="programlisting cpp">typedef <span class="type">BArchivable*</span> (*<code class="function">instantiation_func</code>) (<code class="classname">BMessage</code>*)</pre><p>
|
||
This type is a pointer to a function that can instantiate an object from
|
||
a <code class="classname">BMessage</code> archive and return a pointer to the new object. The
|
||
<code class="methodname">Instantiate()</code> member function of
|
||
<a class="link" href="BArchivable.html" title="BArchivable"><code class="classname">BArchivable</code></a> is such a function.
|
||
</p><p>
|
||
See also:
|
||
<a class="link" href="TheSupportKit_Functions.html#find_instantiation_func" title="find_instantiation_func()"><code class="function">find_instantiation_func()</code></a>
|
||
</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="Integer_Types"></a><a id="uchar"></a>
|
||
<a id="int8"></a> <a id="uint8"></a>
|
||
<a id="vint8"></a> <a id="vuint8"></a>
|
||
<a id="int16"></a> <a id="uint16"></a>
|
||
<a id="vint16"></a> <a id="vuint16"></a>
|
||
<a id="int32"></a> <a id="uint32"></a>
|
||
<a id="vint32"></a> <a id="vuint32"></a>
|
||
<a id="int64"></a> <a id="uint64"></a>
|
||
<a id="vint64"></a> <a id="vuint64"></a>
|
||
Integer Types</h3></div></div></div><a id="id1289894" class="indexterm"></a><a id="id1289901" class="indexterm"></a><a id="id1289908" class="indexterm"></a><a id="id1289914" class="indexterm"></a><a id="id1289921" class="indexterm"></a><a id="id1289928" class="indexterm"></a><a id="id1289935" class="indexterm"></a><a id="id1289942" class="indexterm"></a><a id="id1289949" class="indexterm"></a><a id="id1289956" class="indexterm"></a><a id="id1289963" class="indexterm"></a><a id="id1289970" class="indexterm"></a><a id="id1289977" class="indexterm"></a><a id="id1289984" class="indexterm"></a><a id="id1289991" class="indexterm"></a><a id="id1289998" class="indexterm"></a><a id="id1290005" class="indexterm"></a><p>
|
||
Declared in: <code class="filename">support/SupportDefs.h</code>
|
||
</p><pre class="programlisting cpp">typedef <span class="type">unsigned char</span> <span class="type">uchar</span>
|
||
typedef <span class="type">signed char</span> <span class="type">int8</span>
|
||
typedef <span class="type">unsigned char</span> <span class="type">uint8</span>
|
||
typedef <span class="type">volatile signed char</span> <span class="type">vint8</span>
|
||
typedef <span class="type">volatile unsigned char</span> <span class="type">vuint8</span>
|
||
typedef <span class="type">short</span> <span class="type">int16</span>
|
||
typedef <span class="type">unsigned short</span> <span class="type">uint16</span>
|
||
typedef <span class="type">volatile short</span> <span class="type">vint16</span>
|
||
typedef <span class="type">volatile unsigned short</span> <span class="type">vuint16</span>
|
||
typedef <span class="type">long</span> <span class="type">int32</span>
|
||
typedef <span class="type">unsigned long</span> <span class="type">uint32</span>
|
||
typedef <span class="type">volatile long</span> <span class="type">vint32</span>
|
||
typedef <span class="type">volatile unsigned long</span> <span class="type">vuint32</span>
|
||
typedef <span class="type">long long</span> <span class="type">int64</span>
|
||
typedef <span class="type">unsigned long long</span> <span class="type">uint64</span>
|
||
typedef <span class="type">volatile long long</span> <span class="type">vint64</span>
|
||
typedef <span class="type">volatile unsigned long long</span> <span class="type">vuint64</span></pre><p>
|
||
These type names are defined as convenient shorthands for standard
|
||
integers of various sizes. They're used in place of
|
||
<span class="type">int</span>, <span class="type">short</span>, and <span class="type">long</span>
|
||
throughout the BeOS API.
|
||
</p><p>
|
||
The number at the end of the type name indicates the size of the integer.
|
||
For example, a <span class="type">uint32</span> is an unsigned 32-bit value. The type is guaranteed
|
||
to be defined to its stated size for all platforms (thus their exact
|
||
definitions may vary from platform to platform).
|
||
</p><p>
|
||
Using these types will make the code you write more portable. They'll
|
||
help avoid problems as the operating system and your application move to
|
||
other platforms.
|
||
</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="status_t"></a>status_t</h3></div></div></div><a id="id1290201" class="indexterm"></a><p>Declared in: <code class="filename">support/SupportDefs.h</code></p><pre class="programlisting cpp">typedef <span class="type">int32</span> <span class="type">status_t</span></pre><p>
|
||
This type indicates an error code; it's used mainly for function return
|
||
values.
|
||
</p><p>
|
||
See also:
|
||
"<a class="xref" href="TheSupportKit_Error_Codes.html" title="Error Codes">Error Codes</a>"
|
||
</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="type_code"></a>type_code</h3></div></div></div><a id="id1290254" class="indexterm"></a><p>
|
||
Declared in: <code class="filename">support/SupportDefs.h</code>
|
||
</p><pre class="programlisting cpp">typedef <span class="type">uint32</span> <span class="type">type_code</span></pre><p>
|
||
This type is used for the integer codes that indicate a particular data
|
||
type. The codes—such as <code class="constant">B_UINT32_TYPE</code> and <code class="constant">B_MIME_TYPE</code>—mark
|
||
the type of data added to a message or stored as a resource and also
|
||
appear in other contexts.
|
||
</p><p>
|
||
See also: "<a class="xref" href="TheSupportKit_Constants.html#Constants_Type_Codes" title="Type Codes">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
Type Codes</a>",
|
||
the <a class="link" href="BMessage.html" title="BMessage"><code class="classname">BMessage</code></a> class in the Application Kit, the
|
||
<a class="link" href="BResources.html" title="BResources"><code class="classname">BResources</code></a> class in the Storage Kit
|
||
</p></div></div><div id="footer"><hr /><div id="footerT">Prev: <a href="TheSupportKit_Error_Codes.html">Error Codes</a> Up: <a href="TheSupportKit.html">The Support Kit</a> Next: <a href="TheSupportKit_TLS.html">Thread Local Storage</a> </div><div id="footerB"><div id="footerBL"><a href="TheSupportKit_Error_Codes.html" title="Error Codes"><img src="./images/navigation/prev.png" alt="Prev" /></a> <a href="TheSupportKit.html" title="The Support Kit"><img src="./images/navigation/up.png" alt="Up" /></a> <a href="TheSupportKit_TLS.html" title="Thread Local Storage"><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>
|