dc_adm_get_nd_status - Acquire the status of a specified OpenTP1 node

Format

ANSI C, C++

#include <dcadm.h>
int dc_adm_get_nd_status (char *node_id, DCLONG flags)

K&R C

#include <dcadm.h>
int dc_adm_get_nd_status (node_id, flags)
char       *node_id;
DCLONG      flags;

Description

The function dc_adm_get_nd_status() acquires the status of a specified OpenTP1 node.

This function acquires the status of the execution system when the function dc_adm_get_nd_status() is called with a specified OpenTP1 node for the system switch configuration.

Arguments whose value is set in the UAP

node_id

Specify the pointer to the node identifier. Add a null character after the node identifier.

The length of the node identifier must be equal to the length defined by DCADM_NODE_ID_LEN. If a node identifier with a different length is specified, the function returns with an error.

flags

Specify DCNOFLAGS.

Return values

When the return value is positive (indicating the OpenTP1 node status):

Return valueReturn value (numeric)Explanation
DCADM_STAT_NOT_UP9Communication with the specified OpenTP1 node is impossible for the following reason:
  • The OpenTP1 at the OpenTP1 node must be defined or redefined with the dcsetup command
  • The value specified in the multinode physical definition is incorrect (the OpenTP1 node is not defined or the specified host name or port number is incorrect).
  • A communication error occurred (power is not supplied to the OpenTP1 node machine or a network error occurred).
DCADM_STAT_TERM8The OpenTP1 node is halted or is being terminated abnormally.
DCADM_STAT_START_NORMAL2The OpenTP1 node is normally being started.
DCADM_STAT_START_RECOVER3The OpenTP1 node is normally being restarted.
DCADM_STAT_ONLINE4The OpenTP1 node is online.
DCADM_STAT_STOP5The OpenTP1 node is normally being terminated.
DCADM_STAT_STOPA6The OpenTP1 node is being terminated according to plan A.
DCADM_STAT_STOPB7The OpenTP1 node is being terminated according to plan B.
DCADM_STAT_SWAP10The system is being switched.

When the return value is negative (indicating an error):

Return valueReturn value (numeric)Explanation
DCADMER_COMM-1851An inter-process communication error occurred.
DCADMER_PARAM-1852The value specified for the argument is invalid.
DCADMER_PROTO-1854The function dc_rpc_open() was not called.
DCADMER_MEMORY-1861The memory became insufficient.
DCADMER_DEF-1862An incorrect value is specified in the multinode configuration definition or in the multinode physical definition.
DCADMER_MULTI_DEF-1864N is specified for multi_node_option in the system common definition.
The TP1/Multi is not installed in the system.
The correct version TP1/Multi is not installed in the system.
DCADMER_REMOTE-1866The specified OpenTP1 node cannot use the multinode facility for the following reason:
  • N is specified for multi_node_option in the system common definition.
  • The TP1/Multi is not installed in the system.
  • The correct version TP1/Multi is not installed in the system.
  • The memory became insufficient.
DCADMER_NODE_NOT_EXIST-1867The node identified by node_id is not included in the OpenTP1 nodes.