'\" t
.\"     Title: afReadMisc
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: 03/06/2013
.\"    Manual: \ \&
.\"    Source: Audio File Library 0.3.6
.\"  Language: English
.\"
.TH "AFREADMISC" "3" "03/06/2013" "Audio File Library 0\&.3\&.6" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
afReadMisc, afWriteMisc, afSeekMisc \- access miscellaneous metadata in an audio file
.SH "SYNOPSIS"
.sp
.nf
#include <audiofile\&.h>
.fi
.sp
.nf
int afReadMisc (AFfilehandle file, int miscid, void *buffer, int nbytes);
.fi
.sp
.nf
int afWriteMisc (AFfilehandle file, int miscid, const void *buffer, int nbytes);
.fi
.sp
.nf
int afSeekMisc (AFfilehandle file, int miscid, int offbytes);
.fi
.SH "DESCRIPTION"
.sp
afReadMisc reads up to \fInbytes\fR from the miscellaneous data chunk identified by \fImiscid\fR in \fIfile\fR\&.
.sp
afWriteMisc writes up to \fInbytes\fR to the miscellaneous data chunk identified by \fImiscid\fR in \fIfile\fR\&.
.sp
afSeekMisc changes the current offset within the miscellaneous data chunk identified by \fImiscid\fR to the offset \fIoffbytes\fR\&.
.SH "RETURN VALUE"
.sp
afReadMisc returns the number of bytes read from the specified miscellaneous chunk into the buffer referred to by \fIbuffer\fR\&.
.sp
afWriteMisc returns the number of bytes written to the specified miscellaneous chunk from the buffer referred to by \fIbuffer\fR\&.
.sp
afSeekMisc returns the new location of the logical data pointer as measured as an offset in bytes from the beginning of the miscellaneous chunk\(cqs data area\&.
.SH "ERRORS"
.sp
afReadMisc, afWriteMisc, and afSeekMisc can produce the following error codes:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

AF_BAD_READ
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

AF_BAD_WRITE
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

AF_BAD_MISCSEEK
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

AF_BAD_MISCID
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

AF_BAD_TRACKID
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

AF_BAD_FILEHANDLE
.RE
.SH "AUTHOR"
.sp
Michael Pruett <michael@68k\&.org>