Please enable JavaScript to view this site.

ESL Documentation

Navigation: ESL Documentation > ESL APPC Support

Subroutine Descriptions

Scroll Prev Top Next More

The following table summarizes the APPC subroutines. Following the summary, each subroutine is discussed in detail. In this table, the subroutines are grouped by the functions that they perform. Each subroutine is listed alphabetically within the section.

Subroutine

Description

Profile Access

APPCSetInitProfile

Initializes or updates profile information for a conversation that calls APPCStart.

APPCSetAcceptProfile

Initializes or updates profile information for a conversation that calls APPCAcceptStart.

APPCGetInitProfile

Obtains a copy of the profile information previously saved.

This call should be used by a program that calls APPCStart.

APPCGetAcceptProfile

Obtains a copy of the profile information previously saved.

This call should be used by a program that calls APPCAcceptStart.

APPCGetInitProfileNames

Returns the list of profile names currently stored in the ESL APPC profile file (ESLAPPCI.INI)

Used with ESL APPC initiator programs.

APPCGetAcceptProfileNames

Returns the list of profile names currently stored in the ESL APPC profile file (ESLAPPCA.INI) used with ESL APPC acceptor programs.

Send/Receive String Data

APPCStart

Initiates a conversation with a program in another machine.

APPCGetString

Obtains data from a partner application when notified that the data has become available.

APPCAcceptStart

Accepts a conversation initiated by a program in another machine.

APPCGetSystemError

Gets error information when a system error is signalled. This subroutine should be called in a response to the APPCSystemError event notification.

APPCSendString

Sends data to a partner.

APPCFlush

Forces all buffered information to be sent to the partner program on another machine.

APPCReadyToReceive

Sends an indication to the partner program that your program is ready to receive data.

This gives the partner program authority to send.

APPCEnd

Terminates an existing conversation with a partner program on another machine.

Send/Receive Non-String Data

APPCGetDLLData

Called from a user-written DLL subroutine to obtain a buffer of data sent by a partner application upon notification that the data has become available.

APPCSendDLLData

Called from a user-written DLL subroutine to send a buffer of data to a partner.

Confirmation Processing

APPCRequestConfirm

Sends a request for confirmation to the partner program to synchronize processing.

This call also flushes all buffered information to the partner program.

APPCSendConfirmed

Notifies its partner that it has successfully processed all data received prior to the partner's confirmation request.

APPCSendError

Notifies a partner program that an application error has occurred.

Use this subroutine in conjunction with APPCSendConfirmed to synchronize processing with the partner program.

Switch Conversation State

APPCReceiveNotify

Requests receipt of data. When data is available, it is indicated by the APPCData event notification.

Call APPCGetString to get this data.

APPCRequestToSend

Sends an indication to the partner program that your program wants to send data.

APPCTestReqToSend

Queries if the partner program wants to send data.

Utility Subroutines

APPCConvertA2E

Performs ASCII to EBCDIC conversion.

APPCConvertE2A

Performs EBCDIC to ASCII conversion.

APPCGetInfo

Obtains a copy of the conversation characteristics for the CONVERSATION_ID specified in the call.