isCOBOL Evolve : Appendices : Library Routines : IWC$GET
IWC$GET
The IWC$GET library routine receives a message from the embedding HTML page in WebClient environment. For more information about embedding a WebClient application within an HTML page, see Embedding the COBOL application in an HTML page.
 
Syntax:
 CALL "IWC$GET" USING iwcStructure
                      [timeout]
                GIVING returnCode
Parameters:
iwcStructure
Group item
Receives the message information. It must have the following structure:
 
01 iwcStructure.
   03 iwcAction pic x(n).
   03 iwcData pic x(n).
   03 iwcBytes pic x(n).
 
iwcAction
Action required by the HTML page, i.e. "close".
 
iwcData
Human-readable data.
 
iwcBytes
Binary data.
 
The iwcStructure items can be defined as X ANY LENGTH.
Some fields may be empty, depending on what the HTML page sends.
timeout
PIC 9(n) or numeric literal
Specifies the number of hundreds of seconds that the routine must wait for a message. If no message is received in the specified time frame, then the routine exits with a return-code value of 99.
If this parameter is omitted, then the routine waits until a message is received.
Return code:
returnCode can be any signed numeric data item.
-1
Operation failed.
Ensure you’re running in WebClient environment and you previously successfully called the IWC$INIT routine
0
Operation successful, message received
99
Timeout, no message received
Examples:
Example - receive a message from the HTML page
       working-storage section.              
       ...
       01  iwc-struct.
           03 iwc-action              pic x any length.
           03 iwc-data                pic x any length.
           03 iwc-bytes               pic x any length.
       ...
       
       procedure division.       
       ...
           initialize iwc-struct.
           call "IWC$GET" using iwc-struct.