<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>sc68fordevelopers: /home/mandrake/rpm/BUILD/sc68-2.2.1/file68/rsc68.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>/home/mandrake/rpm/BUILD/sc68-2.2.1/file68/rsc68.h File Reference</h1>sc68 resources access.
<a href="#_details">More...</a>
<p>
<code>#include "<a class="el" href="istream68_8h_source.html">file68/istream68.h</a>"</code><br>
<p>
<a href="rsc68_8h_source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="struct__istream__t.html">istream_t</a> *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="rsc68_8h.html#d0cb288ed2eaa90d4fb7c9dd15ae2ebd">SC68rsc_handler_t</a> )(<a class="el" href="rsc68_8h.html#de0887ef6d0209220eec0850a8ec3f9b">SC68rsc_t</a>, const char *, int)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resource handle function type. <a href="#d0cb288ed2eaa90d4fb7c9dd15ae2ebd"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="rsc68_8h.html#de0887ef6d0209220eec0850a8ec3f9b">SC68rsc_t</a> { <a class="el" href="rsc68_8h.html#de0887ef6d0209220eec0850a8ec3f9b1ff4f07e52f19352004a07531d985a62">SC68rsc_replay</a>,
<a class="el" href="rsc68_8h.html#de0887ef6d0209220eec0850a8ec3f9b1df202733f646559628d0999ab346be1">SC68rsc_config</a>,
<a class="el" href="rsc68_8h.html#de0887ef6d0209220eec0850a8ec3f9baa1e457242feb77139a6c886cb3ef953">SC68rsc_sample</a>,
<a class="el" href="rsc68_8h.html#de0887ef6d0209220eec0850a8ec3f9b1404f6310a16aeb580bdd20cf6275674">SC68rsc_dll</a>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">SC68 resource file type. <a href="rsc68_8h.html#de0887ef6d0209220eec0850a8ec3f9b">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="rsc68_8h.html#fe0af008e759be995364e3420bdb49ea">SC68rsc_set_share</a> (const char *path)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set shared resource path. <a href="#fe0af008e759be995364e3420bdb49ea"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="rsc68_8h.html#4959cd9063548fa0c51d936b6fe5e3b5">SC68rsc_set_user</a> (const char *path)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set user resource path. <a href="#4959cd9063548fa0c51d936b6fe5e3b5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="83767a517506bd457baaea787c44a7a4"></a><!-- doxytag: member="rsc68.h::SC68rsc_get_path" ref="83767a517506bd457baaea787c44a7a4" args="(const char **share, const char **user)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="rsc68_8h.html#83767a517506bd457baaea787c44a7a4">SC68rsc_get_path</a> (const char **share, const char **user)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get resource pathes. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="rsc68_8h.html#d0cb288ed2eaa90d4fb7c9dd15ae2ebd">SC68rsc_handler_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="rsc68_8h.html#7de32d2c6a37f576e7fdb03130793c52">SC68rsc_set_handler</a> (<a class="el" href="rsc68_8h.html#d0cb288ed2eaa90d4fb7c9dd15ae2ebd">SC68rsc_handler_t</a> fct)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set/Get resource handler. <a href="#7de32d2c6a37f576e7fdb03130793c52"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct__istream__t.html">istream_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="rsc68_8h.html#814a5b0f8201fa58110ee23bcfdd4711">SC68rsc_open</a> (<a class="el" href="rsc68_8h.html#de0887ef6d0209220eec0850a8ec3f9b">SC68rsc_t</a> type, const char *name, int mode)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open a resource in given mode. <a href="#814a5b0f8201fa58110ee23bcfdd4711"></a><br></td></tr>
</table>
<hr><h2>Detailed Description</h2>
sc68 resources access.
<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd>Benjamin Gerard <<a href="mailto:ben@sashipa.com">ben@sashipa.com</a>> </dd></dl>
<dl class="date" compact><dt><b>Date:</b></dt><dd>1998/10/07 </dd></dl>
<dl class="rcs" compact><dt><b>Id</b></dt><dd><a class="el" href="rsc68_8h.html" title="sc68 resources access.">rsc68.h</a>,v 2.2 2003/09/20 19:24:30 benjihan Exp </dd></dl>
<hr><h2>Typedef Documentation</h2>
<a class="anchor" name="d0cb288ed2eaa90d4fb7c9dd15ae2ebd"></a><!-- doxytag: member="rsc68.h::SC68rsc_handler_t" ref="d0cb288ed2eaa90d4fb7c9dd15ae2ebd" args=")(SC68rsc_t, const char *, int)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="struct__istream__t.html">istream_t</a>*(* <a class="el" href="rsc68_8h.html#d0cb288ed2eaa90d4fb7c9dd15ae2ebd">SC68rsc_handler_t</a>)(<a class="el" href="rsc68_8h.html#de0887ef6d0209220eec0850a8ec3f9b">SC68rsc_t</a>, const char *, int) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Resource handle function type.
<p>
</div>
</div><p>
<hr><h2>Enumeration Type Documentation</h2>
<a class="anchor" name="de0887ef6d0209220eec0850a8ec3f9b"></a><!-- doxytag: member="rsc68.h::SC68rsc_t" ref="de0887ef6d0209220eec0850a8ec3f9b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="rsc68_8h.html#de0887ef6d0209220eec0850a8ec3f9b">SC68rsc_t</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
SC68 resource file type.
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="de0887ef6d0209220eec0850a8ec3f9b1ff4f07e52f19352004a07531d985a62"></a><!-- doxytag: member="SC68rsc_replay" ref="de0887ef6d0209220eec0850a8ec3f9b1ff4f07e52f19352004a07531d985a62" args="" -->SC68rsc_replay</em> </td><td>
68000 external replay.
<p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="de0887ef6d0209220eec0850a8ec3f9b1df202733f646559628d0999ab346be1"></a><!-- doxytag: member="SC68rsc_config" ref="de0887ef6d0209220eec0850a8ec3f9b1df202733f646559628d0999ab346be1" args="" -->SC68rsc_config</em> </td><td>
Config file.
<p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="de0887ef6d0209220eec0850a8ec3f9baa1e457242feb77139a6c886cb3ef953"></a><!-- doxytag: member="SC68rsc_sample" ref="de0887ef6d0209220eec0850a8ec3f9baa1e457242feb77139a6c886cb3ef953" args="" -->SC68rsc_sample</em> </td><td>
Sc68 sample files.
<p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="de0887ef6d0209220eec0850a8ec3f9b1404f6310a16aeb580bdd20cf6275674"></a><!-- doxytag: member="SC68rsc_dll" ref="de0887ef6d0209220eec0850a8ec3f9b1404f6310a16aeb580bdd20cf6275674" args="" -->SC68rsc_dll</em> </td><td>
Sc68 dynamic library.
<p>
</td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="fe0af008e759be995364e3420bdb49ea"></a><!-- doxytag: member="rsc68.h::SC68rsc_set_share" ref="fe0af008e759be995364e3420bdb49ea" args="(const char *path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* SC68rsc_set_share </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>path</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set shared resource path.
<p>
The <a class="el" href="rsc68_8h.html#fe0af008e759be995364e3420bdb49ea" title="Set shared resource path.">SC68rsc_set_share()</a> function set the shared resource path. The path will be duplicate by <a class="el" href="string68_8h.html#93d5e608b38ec4aad725d9ea5eab92ef" title="Duplicate a string.">SC68strdup()</a>. If path is null the current path is freed.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>path</em> </td><td>New shared resource path (0 for free).</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>new path (duplicated string). </dd></dl>
<dl compact><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>0</em> </td><td>error (except for freeing) </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="4959cd9063548fa0c51d936b6fe5e3b5"></a><!-- doxytag: member="rsc68.h::SC68rsc_set_user" ref="4959cd9063548fa0c51d936b6fe5e3b5" args="(const char *path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* SC68rsc_set_user </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>path</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set user resource path.
<p>
The <a class="el" href="rsc68_8h.html#4959cd9063548fa0c51d936b6fe5e3b5" title="Set user resource path.">SC68rsc_set_user()</a> function set the user resource path. The path will be duplicate by <a class="el" href="string68_8h.html#93d5e608b38ec4aad725d9ea5eab92ef" title="Duplicate a string.">SC68strdup()</a>. If path is null the current path is freed.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>path</em> </td><td>New user resource path (0 for free).</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>new path (duplicated string). </dd></dl>
<dl compact><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>0</em> </td><td>error (except for freeing) </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="7de32d2c6a37f576e7fdb03130793c52"></a><!-- doxytag: member="rsc68.h::SC68rsc_set_handler" ref="7de32d2c6a37f576e7fdb03130793c52" args="(SC68rsc_handler_t fct)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="rsc68_8h.html#d0cb288ed2eaa90d4fb7c9dd15ae2ebd">SC68rsc_handler_t</a> SC68rsc_set_handler </td>
<td>(</td>
<td class="paramtype"><a class="el" href="rsc68_8h.html#d0cb288ed2eaa90d4fb7c9dd15ae2ebd">SC68rsc_handler_t</a> </td>
<td class="paramname"> <em>fct</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set/Get resource handler.
<p>
The <a class="el" href="rsc68_8h.html#7de32d2c6a37f576e7fdb03130793c52" title="Set/Get resource handler.">SC68rsc_set_handler()</a> function set the current resource handler. If 0 is given as fct parameter the function does not set the handler. In all case the function returns the current handler. See below for more information about the default resource handler.<p>
<dl class="user" compact><dt><b>Resource handler</b></dt><dd>The resource handler is a function called by the <a class="el" href="rsc68_8h.html#814a5b0f8201fa58110ee23bcfdd4711" title="Open a resource in given mode.">SC68rsc_open()</a> function. Some preliminary tests has already been performed. So the handler can assume that the name is not a NULL pointer and the mode is valid (either 1:reading or 2:writing). The resource handler <b>must</b> return an <b>already</b> opened istream_t or 0 in error case.</dd></dl>
<dl class="user" compact><dt><b>Default resource handler</b></dt><dd>The Default handler use a the <a class="el" href="istream68__file_8h.html#13322cdad1da4e12d4ce40998f7f719c" title="Creates a stream for "C" FILE.">istream_file_create()</a> function.<ul>
<li>If open mode is 2 (write mode) the default handler use the user resource path.</li><li>If open mode is 1 (read mode) the default handler tries in this order the user resource path and the shared resource path.</li></ul>
</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>fct</em> </td><td>New resource handler (0 for reading current value). </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>previous value. </dd></dl>
</div>
</div><p>
<a class="anchor" name="814a5b0f8201fa58110ee23bcfdd4711"></a><!-- doxytag: member="rsc68.h::SC68rsc_open" ref="814a5b0f8201fa58110ee23bcfdd4711" args="(SC68rsc_t type, const char *name, int mode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct__istream__t.html">istream_t</a>* SC68rsc_open </td>
<td>(</td>
<td class="paramtype"><a class="el" href="rsc68_8h.html#de0887ef6d0209220eec0850a8ec3f9b">SC68rsc_t</a> </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>mode</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Open a resource in given mode.
<p>
The function <a class="el" href="rsc68_8h.html#814a5b0f8201fa58110ee23bcfdd4711" title="Open a resource in given mode.">SC68rsc_open()</a> function opens an istream_t to access a resource.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>Type of resource to open. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name of resource. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>1:read-access, 2:write-access.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>already opened istream_t stream. </dd></dl>
<dl compact><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>0</em> </td><td>error.</td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="rsc68_8h.html#7de32d2c6a37f576e7fdb03130793c52" title="Set/Get resource handler.">SC68rsc_set_handler()</a> for more info on resource handler. </dd></dl>
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Sep 15 03:58:05 2009 for sc68fordevelopers by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
2ff8806b45ba9c96e77e01e6d40e440b
>
files
>
198
