NAME
irGetExecBuf, irSetExecBuf - manipulate IRP_EXEC_BUF con-
tents
SYNOPSIS
#include <irapi.h>
int irSetExecBuf (channel_id cid, char *name, char *src);
char *irGetExecBuf (channel_id cid, char *name);
DESCRIPTION
These functions may be used to manipulate the contents of
the IRP_EXEC_BUF parameter buffer used with irExec(3IRAPI)
and irSubProg(3IRAPI) in the form of name = value pairs.
Both the name and the value are stored in the IRP_EXEC_BUF
parameter, separated by an '=' sign and terminated by a null
byte. The total size of the buffer may not exceed 2048
(IRD_MAXDATABUFFER) bytes.
The irSetExecBuf function stores a name = value pair in
IRP_EXEC_BUF. If a value for name already exists, it will
be overwritten with the new value. This function will fail
if storing the parameter would cause the maximum
IRP_EXEC_BUF length (IRD_MAXDATABUFFER) to be exceeded.
Setting an existing IRP_EXEC_BUF parameter to the null
string will remove the parameter from the buffer.
NOTE: The length and raw contents of the buffer can be
obtained by using irParam(3IRAPI) functions to get the
values of the IRP_EXEC_BUF_LEN and IRP_EXEC_BUF parameters
directly. The contents of IRP_EXEC_BUF may be cleared
before using this function by setting IRP_EXEC_BUF_LEN to
0. This may be desirable to
prevent data that was inherited from the previous applica-
tion from being passed on to the next application.
The irGetExecBuf function gets the pointer to the value of a
name = value pair in IRP_EXEC_BUF and returns it. If a
value for name does not exist, a null string will be
returned.
EVENT
No event results from the call to these functions.
RETURN VALUE
The IrSetExecBuf function returns:
IRR_OK if the request is successful.
IRR_FAIL if an error occurs.
The IrGetExecBuf function returns:
Character Pointer to the value associated with the name on
success.
A NULL pointer is returned if name was not found.
ERROR
irError is set as follows if an error occurs:
IRER_INVALID if an invalid argument is passed
IRER_SYSERROR if a system error occurs (irSysError is set to
the corresponding errno)
SEE ALSO
irExec(3IRAPI), irSubProg(3IRAPI),
irParam(3IRAPI), IrPARAMETERS(4IRAPI)
VERSION
This is version 11/25/02 of this man page.