NAME
irPhReserve - reserve space for subsequent voice recording
SYNOPSIS
#include <irapi.h>
int irPhReserve (channel_id cid, int tag, int count, const
char *file);
DESCRIPTION
The irPhReserve function reserves count milliseconds of
space in the UNIX file system to record a file encoded in
the algorithm defined in IRP_RECORD_ALGO. Space is reserved
in file. Absolute or relative paths are allowed.
If file is NULL, a unique file name is generated. The
directory is specified by the IRP_SPEECHDIR and IRP_TALKFILE
parameters. The file name consists of all numeric charac-
ters. The API selects the first unique file name starting
with "65535" and counts down until a unique name is found.
The absolute file name is returned with the subsequent
IRE_RESERVE_DONE event.
For example, if irPhReserve is called with file set to the
NULL pointer, IRP_SPEECHDIR is set to /home2/vfs/talkfiles,
IRP_TALKFILE is set to 255 and there is no file
/home2/vfs/talkfiles/255/65535,
/home2/vfs/talkfiles/255/65535 is the unique file name
returned with the IRE_RESERVE_DONE event.
EVENT
The IRE_RESERVE_DONE event occurs with event_mod1 set to
IREM_COMPLETE or IREM_ERROR depending on the success or
failure, respectively. event_text points to the file name
reserved if successful. While the cid awaits this event, it
is placed in the IRS_RESERVING library state.
RETURN VALUE
IRR_OK is returned if request to reserve space is success-
fully initiated.
IRR_FAIL is returned if an error occurs.
ERROR
irError is set as follows if an error occurs:
IRER_INVALID if the cid or count are not valid.
IRER_OVERFLOW if the file name specified by file is greater
than IRD_MAX_FILE_LEN characters in length. This error may
also be produced as a result of converting a relative file
name into an absolute file name.
IRER_SYSERROR if a system or driver call failure occurs
(check irSysErrror for additional information)
VERSION
This is version 8/31/00 of this man page.