NAME
          irRegister - register a process with the voice system

     SYNOPSIS
          #include <irapi.h>

          ir_key_t irRegister (const char *name);

     DESCRIPTION
          The irRegister function registers the calling process,
          referred to as name in an IRAPI application.  Once
          registered, this process may now receive events generated on
          its behalf.

          If the process was executed as a transient application by
          the Application Dispatch (AD) process or with
          irExecs(3IRAPI) or irSubProgs(3IRAPI), it will be passed a
          "-C <chan>" command line option, where <chan> is the channel
          number for which the application process is being executed.
          This channel number may be appended to Iname to uniquely
          register the process for the specific channel.

          Many of the functions in the IRAPI library only work prop-
          erly after the application process has called irRegister, so
          it must be called early during the initialization.
          Processes that use the IRAPI library without calling irRe-
          gister may encounter undesired results.

     EVENT
          No event is generated as a result of a call to irRegister.

     RETURN VALUE
          The QKey of the calling process is returned if the request
          is successful.

          IRR_FAIL is returned if an error occurs.

     ERROR
          irError is set as follows if an error occurs:

          IRER_INVALID if name is not valid, exceeds IRD_MAX_APP_NAME
          in length, or is already in use

          IRER_OVERFLOW if the UNIX tunable parameter PROFILE_SIZE is
          too small to store all save_on_exec irAPI parameters

          IRER_DRIVER_ERROR if a driver call failure occurs (check
          irSysError for additional information)

          IRER_SYSERROR if a system or driver call failure occurs
          (check irSysError for additional information)

     SEE ALSO
          irPostEvent(3IRAPI), irGetQKey(3IRAPI), irAPI.rc(4IRAPI).

     VERSION
          This is version 11/25/02 of this man page.