NAME
irChan2PendingCid, irGrp2PendingCid - Return cid pending on
channel or group init
SYNOPSIS
#include <irapi.h>
channel_id irChan2PendingCid (int chan);
channel_id irGrp2PendingCid (int group);
DESCRIPTION
Function irChan2PendingCid returns a channel_id pending on
channel chan.
Function irGrp2PendingCid returns a channel_id pending on a
channel in group group.
A pending channel_id will result from a call to
irInit(3IRAPI) or irInitGroup(3IRAPI) returning IRS_PENDING.
While irInit(3IRAPI) and irInitGroup(3IRAPI) return the
channel_id when called, functions irChan2PendingCid and
irGrp2PendingCid are convenience functions for applications
not wishing to maintain tables of channel_ids for outstand-
ing channel requests.
EVENT
No event results from a call to either of these functions.
RETURN VALUE
On success, the channel_id pending on the indicated channel
or group.
On failure, IRD_NULL.
ERROR
irError will be set as follows on error:
IRER_INVALID if chan is invalid.
IRER_NOTFOUND if no channel_id is found pending on the indi-
cated channel or group.
SEE ALSO
irInit(3IRAPI), irInitGroup(3IRAPI).
CAVEATS
Nothing prevents a single process from having multiple ini-
tialization requests for a single channel or group. Func-
tions irChan2PendingCid and irGrp2PendingCid will simply
return the first channel_id found matching the channel or
group parameter.
VERSION
This is version 8/31/00 of this man page.