<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Audacious: vfs_common.c 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.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Audacious <span id="projectnumber">$Id:Doxyfile42802007-03-2104:39:00Znenolod$</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<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="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>vfs_common.c File Reference</h1> </div>
</div>
<div class="contents">
<p>Common code for various VFS-stream related operations.
<a href="#_details">More...</a></p>
<div class="textblock"><code>#include "<a class="el" href="vfs_8h_source.html">vfs.h</a>"</code><br/>
<code>#include <string.h></code><br/>
<code>#include <stdlib.h></code><br/>
<code>#include <glib/gprintf.h></code><br/>
</div>
<p><a href="vfs__common_8c_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="plugins-api_8h.html#acf599c059f43e0cca83145eb6b0c93cd">gint</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="vfs__common_8c.html#a69270a0cc66330bd28ad6b808a5d699f">vfs_fputc</a> (<a class="el" href="plugins-api_8h.html#acf599c059f43e0cca83145eb6b0c93cd">gint</a> c, <a class="el" href="structVFSFile.html">VFSFile</a> *stream)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes a character to a stream. <a href="#a69270a0cc66330bd28ad6b808a5d699f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">gchar * </td><td class="memItemRight" valign="bottom"><a class="el" href="vfs__common_8c.html#a0f7e8179e0e055c970685bdd90aeb4e4">vfs_fgets</a> (gchar *s, <a class="el" href="plugins-api_8h.html#acf599c059f43e0cca83145eb6b0c93cd">gint</a> n, <a class="el" href="structVFSFile.html">VFSFile</a> *stream)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads a string of characters from a stream, ending in newline or EOF. <a href="#a0f7e8179e0e055c970685bdd90aeb4e4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="plugins-api_8h.html#acf599c059f43e0cca83145eb6b0c93cd">gint</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="vfs__common_8c.html#a3c4c448c2261a746175da5ba137bd323">vfs_fputs</a> (const gchar *s, <a class="el" href="structVFSFile.html">VFSFile</a> *stream)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes a string to a VFS stream. <a href="#a3c4c448c2261a746175da5ba137bd323"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="plugins-api_8h.html#acf599c059f43e0cca83145eb6b0c93cd">gint</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="vfs__common_8c.html#ad80a4d790c93f0ac138f632ed9ddf037">vfs_vfprintf</a> (<a class="el" href="structVFSFile.html">VFSFile</a> *stream, gchar const *<a class="el" href="audio_8c.html#ac28b2a605e4f23336825cff9ed49d31e">format</a>, va_list args)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes a formatted string to a VFS stream via a va_list of args. <a href="#ad80a4d790c93f0ac138f632ed9ddf037"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="plugins-api_8h.html#acf599c059f43e0cca83145eb6b0c93cd">gint</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="vfs__common_8c.html#a126a23f8290044628688ce97bef2e2c5">vfs_fprintf</a> (<a class="el" href="structVFSFile.html">VFSFile</a> *stream, gchar const *<a class="el" href="audio_8c.html#ac28b2a605e4f23336825cff9ed49d31e">format</a>,...)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes a formatted string to a VFS stream. <a href="#a126a23f8290044628688ce97bef2e2c5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="vfs__common_8c.html#a5f8a272e3af772144b037dbaf11948a3">vfs_file_get_contents</a> (const gchar *<a class="el" href="misc-api_8h.html#a820d8643bcfa9e2641dd6377f804de20">filename</a>, void **buf, gint64 *size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets contents of the file into a buffer. <a href="#a5f8a272e3af772144b037dbaf11948a3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="playlist-api_8h.html#a3ac4dad7ee7fd2890139bff9a134ee9a">gboolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="vfs__common_8c.html#aa21a30e5ad23561c1f0ded19ae353da6">vfs_fget_le16</a> (guint16 *value, <a class="el" href="structVFSFile.html">VFSFile</a> *stream)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads an unsigned 16-bit Little Endian value from the stream into native endian format. <a href="#aa21a30e5ad23561c1f0ded19ae353da6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="playlist-api_8h.html#a3ac4dad7ee7fd2890139bff9a134ee9a">gboolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="vfs__common_8c.html#ab0bba7df59a23b224f4199fe0d79fe24">vfs_fget_le32</a> (guint32 *value, <a class="el" href="structVFSFile.html">VFSFile</a> *stream)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads an unsigned 32-bit Little Endian value from the stream into native endian format. <a href="#ab0bba7df59a23b224f4199fe0d79fe24"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="playlist-api_8h.html#a3ac4dad7ee7fd2890139bff9a134ee9a">gboolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="vfs__common_8c.html#af0ffa7d72c4fa3f11a954f00cae2b18b">vfs_fget_le64</a> (guint64 *value, <a class="el" href="structVFSFile.html">VFSFile</a> *stream)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads an unsigned 64-bit Little Endian value from the stream into native endian format. <a href="#af0ffa7d72c4fa3f11a954f00cae2b18b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="playlist-api_8h.html#a3ac4dad7ee7fd2890139bff9a134ee9a">gboolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="vfs__common_8c.html#af7f21928713fa8b43596ba8f9af66204">vfs_fget_be16</a> (guint16 *value, <a class="el" href="structVFSFile.html">VFSFile</a> *stream)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads an unsigned 16-bit Big Endian value from the stream into native endian format. <a href="#af7f21928713fa8b43596ba8f9af66204"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="playlist-api_8h.html#a3ac4dad7ee7fd2890139bff9a134ee9a">gboolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="vfs__common_8c.html#ad50d28820b8bc50e475013d31be865ee">vfs_fget_be32</a> (guint32 *value, <a class="el" href="structVFSFile.html">VFSFile</a> *stream)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads an unsigned 32-bit Big Endian value from the stream into native endian format. <a href="#ad50d28820b8bc50e475013d31be865ee"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="playlist-api_8h.html#a3ac4dad7ee7fd2890139bff9a134ee9a">gboolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="vfs__common_8c.html#a7fdfe73a6074c28c31ba004dae89ef1b">vfs_fget_be64</a> (guint64 *value, <a class="el" href="structVFSFile.html">VFSFile</a> *stream)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads an unsigned 64-bit Big Endian value from the stream into native endian format. <a href="#a7fdfe73a6074c28c31ba004dae89ef1b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="playlist-api_8h.html#a3ac4dad7ee7fd2890139bff9a134ee9a">gboolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="vfs__common_8c.html#a1c8c755cc4dc9c6bd5891c51fb965a42">vfs_fput_le16</a> (guint16 value, <a class="el" href="structVFSFile.html">VFSFile</a> *stream)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes an unsigned 16-bit native endian value into the stream as a Little Endian value. <a href="#a1c8c755cc4dc9c6bd5891c51fb965a42"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="playlist-api_8h.html#a3ac4dad7ee7fd2890139bff9a134ee9a">gboolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="vfs__common_8c.html#a72e0e776d4c8696569bd031e24cef535">vfs_fput_le32</a> (guint32 value, <a class="el" href="structVFSFile.html">VFSFile</a> *stream)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes an unsigned 32-bit native endian value into the stream as a Big Endian value. <a href="#a72e0e776d4c8696569bd031e24cef535"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="playlist-api_8h.html#a3ac4dad7ee7fd2890139bff9a134ee9a">gboolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="vfs__common_8c.html#ae6a4872f587921d46fdd521fc81685c6">vfs_fput_le64</a> (guint64 value, <a class="el" href="structVFSFile.html">VFSFile</a> *stream)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes an unsigned 64-bit native endian value into the stream as a Big Endian value. <a href="#ae6a4872f587921d46fdd521fc81685c6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="playlist-api_8h.html#a3ac4dad7ee7fd2890139bff9a134ee9a">gboolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="vfs__common_8c.html#a2116f377d297a8c20c4f698d9cb67652">vfs_fput_be16</a> (guint16 value, <a class="el" href="structVFSFile.html">VFSFile</a> *stream)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes an unsigned 16-bit native endian value into the stream as a Big Endian value. <a href="#a2116f377d297a8c20c4f698d9cb67652"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="playlist-api_8h.html#a3ac4dad7ee7fd2890139bff9a134ee9a">gboolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="vfs__common_8c.html#a57b5e4330ddd1b7289d575e9eadf1ab8">vfs_fput_be32</a> (guint32 value, <a class="el" href="structVFSFile.html">VFSFile</a> *stream)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes an unsigned 32-bit native endian value into the stream as a Big Endian value. <a href="#a57b5e4330ddd1b7289d575e9eadf1ab8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="playlist-api_8h.html#a3ac4dad7ee7fd2890139bff9a134ee9a">gboolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="vfs__common_8c.html#a4736df66763f1651f8225365a605f99b">vfs_fput_be64</a> (guint64 value, <a class="el" href="structVFSFile.html">VFSFile</a> *stream)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes an unsigned 64-bit native endian value into the stream as a Big Endian value. <a href="#a4736df66763f1651f8225365a605f99b"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Common code for various VFS-stream related operations. </p>
<p>Routines for string reading and writing and functions for reading and writing endianess-dependant integer values. </p>
<p>Definition in file <a class="el" href="vfs__common_8c_source.html">vfs_common.c</a>.</p>
</div><hr/><h2>Function Documentation</h2>
<a class="anchor" id="af7f21928713fa8b43596ba8f9af66204"></a><!-- doxytag: member="vfs_common.c::vfs_fget_be16" ref="af7f21928713fa8b43596ba8f9af66204" args="(guint16 *value, VFSFile *stream)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="playlist-api_8h.html#a3ac4dad7ee7fd2890139bff9a134ee9a">gboolean</a> vfs_fget_be16 </td>
<td>(</td>
<td class="paramtype">guint16 * </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structVFSFile.html">VFSFile</a> * </td>
<td class="paramname"><em>stream</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reads an unsigned 16-bit Big Endian value from the stream into native endian format. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>Pointer to the variable to read the value into. </td></tr>
<tr><td class="paramname">stream</td><td>A <a class="el" href="structVFSFile.html">VFSFile</a> object representing the stream. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>TRUE if read was succesful, FALSE if there was an error. </dd></dl>
<p>Definition at line <a class="el" href="vfs__common_8c_source.html#l00246">246</a> of file <a class="el" href="vfs__common_8c_source.html">vfs_common.c</a>.</p>
</div>
</div>
<a class="anchor" id="ad50d28820b8bc50e475013d31be865ee"></a><!-- doxytag: member="vfs_common.c::vfs_fget_be32" ref="ad50d28820b8bc50e475013d31be865ee" args="(guint32 *value, VFSFile *stream)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="playlist-api_8h.html#a3ac4dad7ee7fd2890139bff9a134ee9a">gboolean</a> vfs_fget_be32 </td>
<td>(</td>
<td class="paramtype">guint32 * </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structVFSFile.html">VFSFile</a> * </td>
<td class="paramname"><em>stream</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reads an unsigned 32-bit Big Endian value from the stream into native endian format. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>Pointer to the variable to read the value into. </td></tr>
<tr><td class="paramname">stream</td><td>A <a class="el" href="structVFSFile.html">VFSFile</a> object representing the stream. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>TRUE if read was succesful, FALSE if there was an error. </dd></dl>
<p>Definition at line <a class="el" href="vfs__common_8c_source.html#l00262">262</a> of file <a class="el" href="vfs__common_8c_source.html">vfs_common.c</a>.</p>
</div>
</div>
<a class="anchor" id="a7fdfe73a6074c28c31ba004dae89ef1b"></a><!-- doxytag: member="vfs_common.c::vfs_fget_be64" ref="a7fdfe73a6074c28c31ba004dae89ef1b" args="(guint64 *value, VFSFile *stream)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="playlist-api_8h.html#a3ac4dad7ee7fd2890139bff9a134ee9a">gboolean</a> vfs_fget_be64 </td>
<td>(</td>
<td class="paramtype">guint64 * </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structVFSFile.html">VFSFile</a> * </td>
<td class="paramname"><em>stream</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reads an unsigned 64-bit Big Endian value from the stream into native endian format. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>Pointer to the variable to read the value into. </td></tr>
<tr><td class="paramname">stream</td><td>A <a class="el" href="structVFSFile.html">VFSFile</a> object representing the stream. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>TRUE if read was succesful, FALSE if there was an error. </dd></dl>
<p>Definition at line <a class="el" href="vfs__common_8c_source.html#l00278">278</a> of file <a class="el" href="vfs__common_8c_source.html">vfs_common.c</a>.</p>
</div>
</div>
<a class="anchor" id="aa21a30e5ad23561c1f0ded19ae353da6"></a><!-- doxytag: member="vfs_common.c::vfs_fget_le16" ref="aa21a30e5ad23561c1f0ded19ae353da6" args="(guint16 *value, VFSFile *stream)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="playlist-api_8h.html#a3ac4dad7ee7fd2890139bff9a134ee9a">gboolean</a> vfs_fget_le16 </td>
<td>(</td>
<td class="paramtype">guint16 * </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structVFSFile.html">VFSFile</a> * </td>
<td class="paramname"><em>stream</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reads an unsigned 16-bit Little Endian value from the stream into native endian format. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>Pointer to the variable to read the value into. </td></tr>
<tr><td class="paramname">stream</td><td>A <a class="el" href="structVFSFile.html">VFSFile</a> object representing the stream. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>TRUE if read was succesful, FALSE if there was an error. </dd></dl>
<p>Definition at line <a class="el" href="vfs__common_8c_source.html#l00197">197</a> of file <a class="el" href="vfs__common_8c_source.html">vfs_common.c</a>.</p>
</div>
</div>
<a class="anchor" id="ab0bba7df59a23b224f4199fe0d79fe24"></a><!-- doxytag: member="vfs_common.c::vfs_fget_le32" ref="ab0bba7df59a23b224f4199fe0d79fe24" args="(guint32 *value, VFSFile *stream)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="playlist-api_8h.html#a3ac4dad7ee7fd2890139bff9a134ee9a">gboolean</a> vfs_fget_le32 </td>
<td>(</td>
<td class="paramtype">guint32 * </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structVFSFile.html">VFSFile</a> * </td>
<td class="paramname"><em>stream</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reads an unsigned 32-bit Little Endian value from the stream into native endian format. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>Pointer to the variable to read the value into. </td></tr>
<tr><td class="paramname">stream</td><td>A <a class="el" href="structVFSFile.html">VFSFile</a> object representing the stream. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>TRUE if read was succesful, FALSE if there was an error. </dd></dl>
<p>Definition at line <a class="el" href="vfs__common_8c_source.html#l00213">213</a> of file <a class="el" href="vfs__common_8c_source.html">vfs_common.c</a>.</p>
</div>
</div>
<a class="anchor" id="af0ffa7d72c4fa3f11a954f00cae2b18b"></a><!-- doxytag: member="vfs_common.c::vfs_fget_le64" ref="af0ffa7d72c4fa3f11a954f00cae2b18b" args="(guint64 *value, VFSFile *stream)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="playlist-api_8h.html#a3ac4dad7ee7fd2890139bff9a134ee9a">gboolean</a> vfs_fget_le64 </td>
<td>(</td>
<td class="paramtype">guint64 * </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structVFSFile.html">VFSFile</a> * </td>
<td class="paramname"><em>stream</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reads an unsigned 64-bit Little Endian value from the stream into native endian format. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>Pointer to the variable to read the value into. </td></tr>
<tr><td class="paramname">stream</td><td>A <a class="el" href="structVFSFile.html">VFSFile</a> object representing the stream. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>TRUE if read was succesful, FALSE if there was an error. </dd></dl>
<p>Definition at line <a class="el" href="vfs__common_8c_source.html#l00229">229</a> of file <a class="el" href="vfs__common_8c_source.html">vfs_common.c</a>.</p>
</div>
</div>
<a class="anchor" id="a0f7e8179e0e055c970685bdd90aeb4e4"></a><!-- doxytag: member="vfs_common.c::vfs_fgets" ref="a0f7e8179e0e055c970685bdd90aeb4e4" args="(gchar *s, gint n, VFSFile *stream)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gchar* vfs_fgets </td>
<td>(</td>
<td class="paramtype">gchar * </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="plugins-api_8h.html#acf599c059f43e0cca83145eb6b0c93cd">gint</a> </td>
<td class="paramname"><em>n</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structVFSFile.html">VFSFile</a> * </td>
<td class="paramname"><em>stream</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reads a string of characters from a stream, ending in newline or EOF. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>A buffer to put the string in. </td></tr>
<tr><td class="paramname">n</td><td>The amount of characters to read. </td></tr>
<tr><td class="paramname">stream</td><td>A <a class="el" href="structVFSFile.html">VFSFile</a> object representing the stream. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The string on success, or NULL. </dd></dl>
<p>Definition at line <a class="el" href="vfs__common_8c_source.html#l00054">54</a> of file <a class="el" href="vfs__common_8c_source.html">vfs_common.c</a>.</p>
</div>
</div>
<a class="anchor" id="a5f8a272e3af772144b037dbaf11948a3"></a><!-- doxytag: member="vfs_common.c::vfs_file_get_contents" ref="a5f8a272e3af772144b037dbaf11948a3" args="(const gchar *filename, void **buf, gint64 *size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vfs_file_get_contents </td>
<td>(</td>
<td class="paramtype">const gchar * </td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void ** </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gint64 * </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets contents of the file into a buffer. </p>
<p>Buffer of filesize bytes is allocated by this function as necessary.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td>URI of the file to read in. </td></tr>
<tr><td class="paramname">buf</td><td>Pointer to a pointer variable of buffer. </td></tr>
<tr><td class="paramname">size</td><td>Pointer to gsize variable that will hold the amount of read data e.g. filesize. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="vfs__common_8c_source.html#l00140">140</a> of file <a class="el" href="vfs__common_8c_source.html">vfs_common.c</a>.</p>
<p>Referenced by <a class="el" href="vfs__async_8c_source.html#l00045">vfs_async_file_get_contents_worker()</a>.</p>
</div>
</div>
<a class="anchor" id="a126a23f8290044628688ce97bef2e2c5"></a><!-- doxytag: member="vfs_common.c::vfs_fprintf" ref="a126a23f8290044628688ce97bef2e2c5" args="(VFSFile *stream, gchar const *format,...)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="plugins-api_8h.html#acf599c059f43e0cca83145eb6b0c93cd">gint</a> vfs_fprintf </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structVFSFile.html">VFSFile</a> * </td>
<td class="paramname"><em>stream</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gchar const * </td>
<td class="paramname"><em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>...</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Writes a formatted string to a VFS stream. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">stream</td><td>A <a class="el" href="structVFSFile.html">VFSFile</a> object representing the stream. </td></tr>
<tr><td class="paramname">format</td><td>A printf-style format string. </td></tr>
<tr><td class="paramname">...</td><td>Optional list of arguments. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The amount of bytes written. </dd></dl>
<p>Definition at line <a class="el" href="vfs__common_8c_source.html#l00119">119</a> of file <a class="el" href="vfs__common_8c_source.html">vfs_common.c</a>.</p>
</div>
</div>
<a class="anchor" id="a2116f377d297a8c20c4f698d9cb67652"></a><!-- doxytag: member="vfs_common.c::vfs_fput_be16" ref="a2116f377d297a8c20c4f698d9cb67652" args="(guint16 value, VFSFile *stream)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="playlist-api_8h.html#a3ac4dad7ee7fd2890139bff9a134ee9a">gboolean</a> vfs_fput_be16 </td>
<td>(</td>
<td class="paramtype">guint16 </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structVFSFile.html">VFSFile</a> * </td>
<td class="paramname"><em>stream</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Writes an unsigned 16-bit native endian value into the stream as a Big Endian value. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>Value to write into the stream. </td></tr>
<tr><td class="paramname">stream</td><td>A <a class="el" href="structVFSFile.html">VFSFile</a> object representing the stream. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>TRUE if read was succesful, FALSE if there was an error. </dd></dl>
<p>Definition at line <a class="el" href="vfs__common_8c_source.html#l00337">337</a> of file <a class="el" href="vfs__common_8c_source.html">vfs_common.c</a>.</p>
</div>
</div>
<a class="anchor" id="a57b5e4330ddd1b7289d575e9eadf1ab8"></a><!-- doxytag: member="vfs_common.c::vfs_fput_be32" ref="a57b5e4330ddd1b7289d575e9eadf1ab8" args="(guint32 value, VFSFile *stream)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="playlist-api_8h.html#a3ac4dad7ee7fd2890139bff9a134ee9a">gboolean</a> vfs_fput_be32 </td>
<td>(</td>
<td class="paramtype">guint32 </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structVFSFile.html">VFSFile</a> * </td>
<td class="paramname"><em>stream</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Writes an unsigned 32-bit native endian value into the stream as a Big Endian value. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>Value to write into the stream. </td></tr>
<tr><td class="paramname">stream</td><td>A <a class="el" href="structVFSFile.html">VFSFile</a> object representing the stream. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>TRUE if read was succesful, FALSE if there was an error. </dd></dl>
<p>Definition at line <a class="el" href="vfs__common_8c_source.html#l00351">351</a> of file <a class="el" href="vfs__common_8c_source.html">vfs_common.c</a>.</p>
</div>
</div>
<a class="anchor" id="a4736df66763f1651f8225365a605f99b"></a><!-- doxytag: member="vfs_common.c::vfs_fput_be64" ref="a4736df66763f1651f8225365a605f99b" args="(guint64 value, VFSFile *stream)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="playlist-api_8h.html#a3ac4dad7ee7fd2890139bff9a134ee9a">gboolean</a> vfs_fput_be64 </td>
<td>(</td>
<td class="paramtype">guint64 </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structVFSFile.html">VFSFile</a> * </td>
<td class="paramname"><em>stream</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Writes an unsigned 64-bit native endian value into the stream as a Big Endian value. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>Value to write into the stream. </td></tr>
<tr><td class="paramname">stream</td><td>A <a class="el" href="structVFSFile.html">VFSFile</a> object representing the stream. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>TRUE if read was succesful, FALSE if there was an error. </dd></dl>
<p>Definition at line <a class="el" href="vfs__common_8c_source.html#l00365">365</a> of file <a class="el" href="vfs__common_8c_source.html">vfs_common.c</a>.</p>
</div>
</div>
<a class="anchor" id="a1c8c755cc4dc9c6bd5891c51fb965a42"></a><!-- doxytag: member="vfs_common.c::vfs_fput_le16" ref="a1c8c755cc4dc9c6bd5891c51fb965a42" args="(guint16 value, VFSFile *stream)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="playlist-api_8h.html#a3ac4dad7ee7fd2890139bff9a134ee9a">gboolean</a> vfs_fput_le16 </td>
<td>(</td>
<td class="paramtype">guint16 </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structVFSFile.html">VFSFile</a> * </td>
<td class="paramname"><em>stream</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Writes an unsigned 16-bit native endian value into the stream as a Little Endian value. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>Value to write into the stream. </td></tr>
<tr><td class="paramname">stream</td><td>A <a class="el" href="structVFSFile.html">VFSFile</a> object representing the stream. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>TRUE if read was succesful, FALSE if there was an error. </dd></dl>
<p>Definition at line <a class="el" href="vfs__common_8c_source.html#l00295">295</a> of file <a class="el" href="vfs__common_8c_source.html">vfs_common.c</a>.</p>
</div>
</div>
<a class="anchor" id="a72e0e776d4c8696569bd031e24cef535"></a><!-- doxytag: member="vfs_common.c::vfs_fput_le32" ref="a72e0e776d4c8696569bd031e24cef535" args="(guint32 value, VFSFile *stream)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="playlist-api_8h.html#a3ac4dad7ee7fd2890139bff9a134ee9a">gboolean</a> vfs_fput_le32 </td>
<td>(</td>
<td class="paramtype">guint32 </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structVFSFile.html">VFSFile</a> * </td>
<td class="paramname"><em>stream</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Writes an unsigned 32-bit native endian value into the stream as a Big Endian value. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>Value to write into the stream. </td></tr>
<tr><td class="paramname">stream</td><td>A <a class="el" href="structVFSFile.html">VFSFile</a> object representing the stream. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>TRUE if read was succesful, FALSE if there was an error. </dd></dl>
<p>Definition at line <a class="el" href="vfs__common_8c_source.html#l00309">309</a> of file <a class="el" href="vfs__common_8c_source.html">vfs_common.c</a>.</p>
</div>
</div>
<a class="anchor" id="ae6a4872f587921d46fdd521fc81685c6"></a><!-- doxytag: member="vfs_common.c::vfs_fput_le64" ref="ae6a4872f587921d46fdd521fc81685c6" args="(guint64 value, VFSFile *stream)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="playlist-api_8h.html#a3ac4dad7ee7fd2890139bff9a134ee9a">gboolean</a> vfs_fput_le64 </td>
<td>(</td>
<td class="paramtype">guint64 </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structVFSFile.html">VFSFile</a> * </td>
<td class="paramname"><em>stream</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Writes an unsigned 64-bit native endian value into the stream as a Big Endian value. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>Value to write into the stream. </td></tr>
<tr><td class="paramname">stream</td><td>A <a class="el" href="structVFSFile.html">VFSFile</a> object representing the stream. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>TRUE if read was succesful, FALSE if there was an error. </dd></dl>
<p>Definition at line <a class="el" href="vfs__common_8c_source.html#l00323">323</a> of file <a class="el" href="vfs__common_8c_source.html">vfs_common.c</a>.</p>
</div>
</div>
<a class="anchor" id="a69270a0cc66330bd28ad6b808a5d699f"></a><!-- doxytag: member="vfs_common.c::vfs_fputc" ref="a69270a0cc66330bd28ad6b808a5d699f" args="(gint c, VFSFile *stream)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="plugins-api_8h.html#acf599c059f43e0cca83145eb6b0c93cd">gint</a> vfs_fputc </td>
<td>(</td>
<td class="paramtype"><a class="el" href="plugins-api_8h.html#acf599c059f43e0cca83145eb6b0c93cd">gint</a> </td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structVFSFile.html">VFSFile</a> * </td>
<td class="paramname"><em>stream</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Writes a character to a stream. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">c</td><td>A character to write to the stream. </td></tr>
<tr><td class="paramname">stream</td><td>A <a class="el" href="structVFSFile.html">VFSFile</a> object representing the stream. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The character on success, or EOF. </dd></dl>
<p>Definition at line <a class="el" href="vfs__common_8c_source.html#l00035">35</a> of file <a class="el" href="vfs__common_8c_source.html">vfs_common.c</a>.</p>
</div>
</div>
<a class="anchor" id="a3c4c448c2261a746175da5ba137bd323"></a><!-- doxytag: member="vfs_common.c::vfs_fputs" ref="a3c4c448c2261a746175da5ba137bd323" args="(const gchar *s, VFSFile *stream)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="plugins-api_8h.html#acf599c059f43e0cca83145eb6b0c93cd">gint</a> vfs_fputs </td>
<td>(</td>
<td class="paramtype">const gchar * </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structVFSFile.html">VFSFile</a> * </td>
<td class="paramname"><em>stream</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Writes a string to a VFS stream. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>A string to write to the stream. </td></tr>
<tr><td class="paramname">stream</td><td>A <a class="el" href="structVFSFile.html">VFSFile</a> object representing the stream. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The amount of bytes written. </dd></dl>
<p>Definition at line <a class="el" href="vfs__common_8c_source.html#l00086">86</a> of file <a class="el" href="vfs__common_8c_source.html">vfs_common.c</a>.</p>
<p>Referenced by <a class="el" href="vfs__common_8c_source.html#l00101">vfs_vfprintf()</a>.</p>
</div>
</div>
<a class="anchor" id="ad80a4d790c93f0ac138f632ed9ddf037"></a><!-- doxytag: member="vfs_common.c::vfs_vfprintf" ref="ad80a4d790c93f0ac138f632ed9ddf037" args="(VFSFile *stream, gchar const *format, va_list args)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="plugins-api_8h.html#acf599c059f43e0cca83145eb6b0c93cd">gint</a> vfs_vfprintf </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structVFSFile.html">VFSFile</a> * </td>
<td class="paramname"><em>stream</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gchar const * </td>
<td class="paramname"><em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">va_list </td>
<td class="paramname"><em>args</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Writes a formatted string to a VFS stream via a va_list of args. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">stream</td><td>A <a class="el" href="structVFSFile.html">VFSFile</a> object representing the stream. </td></tr>
<tr><td class="paramname">format</td><td>A printf-style format string. </td></tr>
<tr><td class="paramname">args</td><td>A va_list of args to use. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>value The amount of bytes written. </dd></dl>
<p>Definition at line <a class="el" href="vfs__common_8c_source.html#l00101">101</a> of file <a class="el" href="vfs__common_8c_source.html">vfs_common.c</a>.</p>
<p>Referenced by <a class="el" href="vfs__common_8c_source.html#l00119">vfs_fprintf()</a>.</p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Apr 17 2011 for Audacious by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
