Kernel 8.0 APIs Banner
Office of Information and Technology (OIT) Banner
[skip navigation]

CALL^%ZISTCP: Make TCP/IP Connection (Remote System)

Reference Type: Supported, Category: Device Handler, ICR#: 2118

Description

The CALL^%ZISTCP API is used to make a TCP/IP connection to a remote system.

NOTE: This API is IPv6 compliant.

Format

  CALL^%ZISTCP

Make sure to perform the following steps before calling this API:

  1. NEW all non-namespaced variables.

  2. Set all input variables.

  3. Call the API.

Input Variables

IPADDRESS:

(required) This is the Internet Protocol (IP) address of the Host system to which it connects. It must be in either of the following formats:

  • IPv4—Format of four numbers separated by dots (e.g., 99.99.9.999)

  • IPv6—Format of six numbers separated by colons (e.g., fe80::206a:b21b:fbd5:c93).
SOCKET:

(required) This is the socket to connect to on the remote host. It is an integer from 1-65535. Values below 5000 are reserved for standard Internet services (e.g., SMTP mail).
TIMEOUT:

(optional) This is the timeout to apply to the Open.

Output Variables

IO:

If the connection is made then the IO variable holds the implementation value that is used to reference the connection.
POP:

This output variable reports the connection status:

  • Successful—A value of zero (0) means the connection was successful.

  • Unsuccessful—A positive value means the connection failed.

It works the same as a call to ^%ZIS(): Standard Device Call.