Please enable JavaScript to view this site.

ESL Documentation

Field Types

Obtains a copy of the profile information previously saved. This call should be used by a program that calls APPCStart.

Declaration:

subroutine APPCGetInitProfile(string: PROFILE_NAME,
                              string: LOCAL_LU_ALIAS_NAME,
                              string: PARTNER_LU_ALIAS_NAME,
                              string: PARTNER_TP_NAME,
                              string: MODE_NAME,
                              string: SECURITY_PARAMETERS,
                              integer:INACTIVITY_TIMEOUT,
                              integer:BUFFER_SIZE,
                              integer:ASCII_TABLE,
                              integer:EBCDIC_TABLE ) 

                     library "eslappc"
 

Arguments:

PROFILE_NAME is a string variable that specifies the name of the profile to be retrieved.

Note:        The PROFILE_NAME argument is the only one that you need to specify for this subroutine call. If the subroutine executes successfully, all other arguments are filled in for you with the stored profile information that you are retrieving. The other arguments are described here only to help you evaluate their contents.

LOCAL_LU_ALIAS_NAME is a string variable that is set to the locally-known name for the logical unit (LU). This name was established during configuration of the communications program on the Create/Change Local APPC Logical Unit Profile pane. Its maximum length is eight characters.

PARTNER_LU_ALIAS_NAME is a string variable that is set to the name of a partner logical unit (LU) profile that was established during configuration of your communications program. Its maximum length is eight characters.

PARTNER_TP_NAME is a string variable that is set to the name of the partner transaction program (TP). Its maximum length is 64 characters. This is the TP name specified in the configuration of the partner's Remotely Attachable Transaction Program Profile. If the partner is invoking an ESL program, the partner TP name must be the same as the profile name specified in the APPCAcceptStart subroutine call, and the partner TP filename must be ESLAPPCA.EXE.

MODE_NAME is a string variable that is set to the mode name. The mode identifies the characteristics of the allocated session. The name will match a mode name established during configuration of your communications program. Its maximum length is eight characters.

SECURITY_PARAMETERS is a string variable that is set to the parameters used to validate access to a partner transaction program and its resources. The following values are valid:

None

The conversation does not use security.

Same

The user ID is verified locally.

PgmUSERID/PASSWORD

The partner logical unit (LU) validates access with the security information provided. Parameters are separated with a forward slash (/).

USERID is the ID of the local user; its maximum length is ten characters. PASSWORD is the password of the local user; its maximum length is ten characters.

 

INACTIVITY_TIMEOUT is an integer variable that is set to the timer value (in seconds) allowing state switching to occur automatically when a conversation with authority to send is inactive for more than the specified number of seconds. This is a value that may require tuning. (Five seconds is a reasonable initial value.) If zero, no check is made to see if the partner application wants to send data between sends. This prevents automatic switching from being initiated by the partner. If automatic switching is disabled, your program, when it has completed sending, must be sure to call the APPCReadyToReceive subroutine, or call the APPCSendString subroutine with the MORE_TO_SEND argument set to APPC_ReadyToReceive.

BUFFER_SIZE is an integer between 0 and 65500 (default 2048) that specifies the buffer size (in bytes) to be used to send and receive data. If zero, a default buffer size of 2K bytes is used. The buffer size must be large enough to contain the largest number of characters or bytes of data to be sent in one call.

ASCII_TABLE is an integer value that is set to the ASCII code page used for conversions. If zero, the current system code page is used.

EBCDIC_TABLE is an integer value that is set to the EBCDIC code page used for conversions. If zero, the international code page, 500, is used.

Remarks:

This routine can be used to verify if a profile exists or to display the current profile settings to a user who may update the values. If a profile does not exist, as indicated by a non-zero errorlevel value, the program must call APPCSetInitProfile to set the values.

Errors:

APPC_NORMAL_COMPLETION

Normal completion.

APPC_ERR_ON_FILE_OPEN

Error opening file or file does not exist.

APPC_ERR_ON_FILE_READ

Error reading file or profile not in profile file.

APPC_ERR_OUT_OF_MEMORY

Out of memory.

APPC_ERR_INV_PROFILE_NAME

Invalid argument: PROFILE_NAME

Example:

response to start
   call APPCGetInitProfile ( Profile,
                             MyLU,
                             PartnerLU,
                             ReceiveTPName,
                             ModeName,
                             NoSecurity,
                             Timeout,
                             Buffer_Size,
                             ASCII_Table,
                             EBCDIC_Table )