Feed a Process with Text

This Subprogram may be used to feed a Client Process with text as if the text had been typed at the keyboard. It may also be used to broadcast to all Client Processes.

Short Name Calling Sequence

STATUS = UIFDPC(PRCNAM,TEXT[,FDMODE])

Long Name Calling Sequence

STATUS = UI_FEED_PROCESS(...)

Input Arguments

PRCNAM (Character) Process Name (See Notes) TEXT (Character) Text String FDMODE (Integer) Feed Mode (See Notes)

Output Arguments

None

Function Value

UI__SUCCESS ) Success UISUCC )

UI__NOT_INITIALIZED ) Package not Initialized UININI )

UI__NO_INPUT ) Client Process not UINOIN ) expecting Input

UI__ILLEGAL_PROCESS ) Illegal Process UIILPC ) Note:

1. The PRCNAM Argument may be used to determine whether the specified text should be fed to a particular Client Process, the currently connected (via UI_CONNECT_PROCESS) Client Process or broadcast to all Client Processes. The syntax is:-

   PRCNAM = ' '

   Feed text string to currently connected Process

   PRCNAM = '*'

   Broadcast text string to all Processes

   PRCNAM = 'acb...'

   Feed text string to Client Process 'abc..'

   If a Client Process name is explicitly specified, or there is no process currently connected, Function Value UI__ILLEGAL_PROCESS will be returned if the process name is illegal.
2. The FDMODE Argument is Optional. It determines whether the Server Process feeds the specified Clients with text irregardless of whether they are actually expecting it (have issued a read request). If FDMODE is absent or set to UI_INPUT_ASYNCHRONOUS (UIASYN) then the text will be sent to the Client Process only if it already has a pending read request, otherwise Function Value UI__NO_INPUT will be returned and the text will not be sent. If FDMODE is set to UI_INPUT_SYNCHRONOUS (UISYNC) then the text will be sent irregardless of whether the Client has a pending read request. Depending on the current state of the communication channel this might cause the Server to ``hang" until the Client reads the text.
3. It is recommended that UI_INPUT_SYNCHRONOUS is used for Broadcasts to all Clients since there is no mechanism of determining which Client did not have the text sent to it for Asynchronous Mode.
4. The Synchronous/Asynchronous Mode Parameters are defined in an Include File described in Appendix B.3.