#include <stddef.h>
Go to the source code of this file.
Definition in file ctgclient.h.
|
Definition at line 40 of file ctgclient.h. |
|
CICS TG ECI V2 the API version identifier. This is the version of the API and should not be confused with the ECI Version that is included in the ECI parameter block field eci_version. Definition at line 49 of file ctgclient.h. |
|
CICS TG ECI V2 the DLL version identifier. This is the build version of the DLL and should not be confused with the API Version. Definition at line 54 of file ctgclient.h. |
|
The Gateway token was not recognized by the Client API. The token is either not valid, or the connection to the Gateway daemon has been lost and the token deleted. Definition at line 434 of file ctgclient.h. |
|
Internal error with the Gateway token list.
Definition at line 468 of file ctgclient.h. |
|
The hostname did not resolve to a valid IP address.
Definition at line 500 of file ctgclient.h. |
|
The port number is not valid. Port numbers must be in the range 1 through 65535. Definition at line 451 of file ctgclient.h. |
|
Failed to establish a connection with the Gateway daemon.
Definition at line 472 of file ctgclient.h. |
|
The connection timed out.
Definition at line 508 of file ctgclient.h. |
|
The connection failed because the Gateway daemon is at an earlier product release than the Client application.
Definition at line 547 of file ctgclient.h. |
|
The Gateway daemon is closing.
Definition at line 529 of file ctgclient.h. |
|
An internal exception occurred in the Gateway daemon.
Definition at line 538 of file ctgclient.h. |
|
The Gateway token has been closed and no new work can be sent to the Gateway daemon.
Definition at line 521 of file ctgclient.h. |
|
The data length was not valid.
Definition at line 414 of file ctgclient.h. |
|
The protocol handler for the port that the Client application is connected to does not accept the request type sent.
Definition at line 552 of file ctgclient.h. |
|
The timeout parameter is not in the range 0 through 3000.
Definition at line 516 of file ctgclient.h. |
|
Deprecated. No longer used. Definition at line 480 of file ctgclient.h. |
|
The connection to the Gateway daemon has been lost.
Definition at line 438 of file ctgclient.h. |
|
The API was unable to allocate sufficient memory to complete the operation.
Definition at line 464 of file ctgclient.h. |
|
There are more systems to return than were requested.
Definition at line 420 of file ctgclient.h. |
|
There are no servers known to the Gateway daemon.
Definition at line 423 of file ctgclient.h. |
|
The hostname is NULL.
Definition at line 504 of file ctgclient.h. |
|
The ECI parameter block pointer is NULL.
Definition at line 512 of file ctgclient.h. |
|
The Gateway token is NULL.
Definition at line 428 of file ctgclient.h. |
|
The Gateway token pointer is NULL.
Definition at line 455 of file ctgclient.h. |
|
One of the parameters is NULL.
Definition at line 442 of file ctgclient.h. |
|
The pointer is NULL.
Definition at line 459 of file ctgclient.h. |
|
The Gateway token does not belong to this process.
Definition at line 488 of file ctgclient.h. |
|
An internal system error has occurred.
Definition at line 417 of file ctgclient.h. |
|
The Gateway token does not belong to this thread.
Definition at line 492 of file ctgclient.h. |
|
Unable to create a trace file at the specified location.
Definition at line 496 of file ctgclient.h. |
|
The trace level is not valid.
Definition at line 446 of file ctgclient.h. |
|
The request type is not recognized by the Gateway daemon.
Definition at line 525 of file ctgclient.h. |
|
The Gateway daemon refused the request because no worker threads were available or the Gateway daemon is closing.
Definition at line 534 of file ctgclient.h. |
|
Definition at line 356 of file ctgclient.h. |
|
Definition at line 347 of file ctgclient.h. |
|
The maximum length of a string returned by CTG_getRcString.
Definition at line 59 of file ctgclient.h. |
|
Null Gateway daemon token.
Definition at line 62 of file ctgclient.h. |
|
The API call completed successfully.
Definition at line 411 of file ctgclient.h. |
|
Trace level 0 disables all tracing.
Definition at line 560 of file ctgclient.h. |
|
Trace level 1 includes exception trace points only.
Definition at line 564 of file ctgclient.h. |
|
Trace level 2 includes event trace points + lower trace levels.
Definition at line 569 of file ctgclient.h. |
|
Trace level 3 includes entry/exit trace points + lower trace levels.
Definition at line 574 of file ctgclient.h. |
|
Trace level 4 includes debug trace points + lower trace levels.
Definition at line 579 of file ctgclient.h. |
|
CTG_ConnToken_t represents a connection to a specific Gateway daemon.
Definition at line 73 of file ctgclient.h. |
|
Attempts to free all resources held by the API, including open Gateway connections. This function can be called in the event of a severe application error, enabling a controlled shutdown even if all Gateway tokens have been lost. Any outstanding ECI_GET_REPLY_WAIT and ECI_GET_SPECIFIC_REPLY_WAIT calls end with CTG_ERR_GWTOK_CLOSED. No new calls can be issued on any Gateway token after the close process has started.
|
|
Closes the connection to the Gateway daemon associated with the specified Gateway token. After successful completion, resources associated with the Gateway daemon connection are released. When the Gateway token is closed, synchronous requests that are in progress can complete and replies for outstanding asynchronous requests can be retrieved using any of the get reply calls. No new ECI_SYNC or ECI_ASYNC calls can be issued after the close process has started. When a Gateway token is closing, and all outstanding replies have been retrieved, any outstanding ECI_GET_REPLY_WAIT calls end with CTG_ERR_GWTOK_CLOSED. This function waits until all synchronous requests are complete and all replies have been retrieved.
|
|
Writes CICS TG internal debugging information to the trace destination. The debug information is written irrespective of trace settings.
|
|
Get the current trace level. Takes a pointer to an int variable, and sets that variable to the current API trace level.
|
|
Gets the API version. This will only change when the API changes.
|
|
Gets the DLL version. This will change when the build level changes.
|
|
Gets the string representation of the return code.
|
|
CTG_listSystems returns a list of all the systems known to the Gateway, including IPIC and logical CICS servers (only available on z/OS). Although the list of systems are known to the Gateway there is no guarantee that a communications link exists or that any of the servers is available * to process requests.
|
|
Establish a remote ECI version 2 connection to a Gateway daemon. This function takes a character pointer for the hostname, an integer for the target port number and a pointer to a Gateway token and an integer for the connection timeout. It establishes a connection to a Gateway daemon Client protocol handler using the specified hostname and port number. If the return code is successful the Gateway token represents the connection to the specified Gateway daemon, this Gateway token is required as an input parameter for the other API calls. This API supports CICS TG remote mode operation. The CICS TG "local" protocol for local mode operation is not supported.
|
|
Sets the maximum length of data that is displayed in ECI version 2 API trace. The function takes a size_t parameter which specifies the maximum amount of data to trace. The trace data length can also be specified by setting the environment variable CTG_CLIENT_DATA_LENGTH to a positive numeric value. The environment variable must be set before the application is started. Use of this function overrides any value obtained from the environment variable.
|
|
Sets the offset into data that is displayed in ECI version 2 API trace. The function takes a size_t parameter which specifies the offset into the data. The trace data offset can also be specified by setting the environment variable CTG_CLIENT_DATA_OFFSET to a positive numeric value. The environment variable must be set before the application is started. Use of this function overrides any value obtained from the environment variable.
|
|
Takes a character pointer to a null terminated string representing the desired trace file destination. If the specified file already exists, trace data is appended. If the API is unable to open the specified file for writing, then the trace destination remains unchanged. Specifying a null pointer causes the trace destination to revert to the default destination of stderr. The trace file can also be specified by setting the environment variable CTG_CLIENT_TRACE_FILE to a filename. Any path/filename that is valid for the operating system is an acceptable value. The environment variable must be set before the application is started. Use of this function overrides any value obtained from the environment variable.
|
|
Set the ECI version 2 API trace level. Takes an int variable representing the desired trace level and sets the API trace level accordingly. The default trace destination is stderr, but this can be overridden by the API function CTG_setAPITraceFile(). The API trace level can also be specified by setting the environment variable CTG_CLIENT_TRACE_LEVEL to the trace level required. Valid values are 0 to 4. The environment variable must be set before the application is started. Use of this function overrides any value obtained from the environment variable.
|
© Copyright IBM Corporation 2011, 2012. All rights reserved.
For legal information, see http://www.ibm.com/legal/copytrade.shtml