NS/main/source/includes/fmodapi375linux/documentation/HTML/FSOUND_SEEKCALLBACK.html

76 lines
3.1 KiB
HTML
Raw Normal View History

2014-12-16 13:36:27 +00:00
<HTML>
<HEAD>
<META NAME="GENERATOR" Content="SOURCEDOC.EXE">
<META HTTP-EQUIV="Content-Type" content="text/html; charset=iso-8859-1">
<TITLE>FSOUND_SEEKCALLBACK</TITLE>
<STYLE>
#flush {margin-left: -10p; margin-right: -0p}
#buttonbar {color: white}
</STYLE>
</HEAD>
<BODY TOPMARGIN=0 BGPROPERTIES="FIXED" BGCOLOR="white">
<FONT FACE="ARIAL">
<SPAN ID="flush">
<A NAME="SEE ALSO">
<TABLE WIDTH="100%" COLS=2 BORDER=0 BGCOLOR="#000000">
<TR ALIGN=RIGHT>
<TD ALIGN=LEFT>
<IMG SRC="banner03.gif" WIDTH="88" HEIGHT="31" BORDER=0>
</TD>
<TD ALIGN=RIGHT VALIGN=TOP>
<FONT FACE="ARIAL" SIZE="2">
<A ID=buttonbar HREF="FSOUND_Sample_Upload.html">
<IMG SRC="u_prev.gif" WIDTH="71" HEIGHT="16" BORDER=0 ALT="Previous Topic">
</A>
<A ID=buttonbar HREF="FSOUND.html">
<IMG SRC="u_index.gif" WIDTH="47" HEIGHT="16" BORDER=0 ALT="Index">
</A>
<A ID=buttonbar HREF="FSOUND_SendData.html">
<IMG SRC="u_next.gif" WIDTH="48" HEIGHT="16" BORDER=0 ALT="Next Topic">
</A>
</FONT></TD><TD WIDTH=15></TD>
</TR>
</TABLE>
</A>
</SPAN>
<A HREF="FSOUND.html#Functions"><H5>[API function]</A></H5>
<H2><A NAME="FSOUND_SEEKCALLBACK">FSOUND_SEEKCALLBACK</A></H2>
Callback for seeking within a file.<BR>
<P>
<B>int F_CALLBACKAPI </B><B> </B><B>FSOUND_SEEKCALLBACK</B><B>(</B><BR>
<B>void *</B><I>handle</I><B>,</B><BR>
<B>int </B><B> </B><I>pos</I><B>,</B><BR>
<B>signed char </B><B> </B><I>mode</I><BR>
<B>);</B><BR>
<H3>Parameters</H3>
<TABLE>
<TR VALIGN=top><TD><I>handle</I></TD>
<TD>This is the handle you returned from the open callback to use for your own file routines.<BR>
</TD><TR VALIGN=top><TD><I>pos</I></TD>
<TD>This is the position or offset to seek by depending on the mode.<BR>
</TD><TR VALIGN=top><TD><I>mode</I></TD>
<TD>This is the seek command. It uses and is compatible with SEEK_SET, SEEK_CUR and SEEK_END from stdio.h, so use them.<BR>
</TD></TABLE>
<H3>Return Value</H3>
If successful, the seek callback returns 0. Otherwise, it returns a nonzero value. On devices incapable of seeking, the return value is undefined.<BR>
<H3>Remarks</H3>
SEEK_END must reposition your file pointer at the END of the file, plus any negative offset. To do this you must know the size of the file, it is suggested you find and store this in the open function. Remember that a SEEK_END position value of -1 is the last byte.<BR>
You must reset your file pointer based on the commands given above.<BR>
___________________<BR>
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, GameCube<BR>
<H3>See Also</H3>
<A HREF="FSOUND_CLOSECALLBACK.html">FSOUND_CLOSECALLBACK</A>
,
<A HREF="FSOUND_File_SetCallbacks.html">FSOUND_File_SetCallbacks</A>
,
<A HREF="FSOUND_OPENCALLBACK.html">FSOUND_OPENCALLBACK</A>
,
<A HREF="FSOUND_READCALLBACK.html">FSOUND_READCALLBACK</A>
,
<A HREF="FSOUND_TELLCALLBACK.html">FSOUND_TELLCALLBACK</A>
<HR><BR><FONT SIZE="-2">This document copyright &copy;Firelight Technologies, Pty, Ltd, 1999-2002. All rights reserved.</FONT><BR>
<FONT SIZE="-2">Generated Thu Dec 15 17:31:33 2005
by SourceDoc v0.10, the automated source code documenter.</FONT><BR>
</BODY>
</HTML>