dc_adm_get_sv_status_begin - Start acquiring the status of a user server

Format

ANSI C, C++

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

K&R C

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

Description

The function dc_adm_get_sv_status_begin() starts acquiring the statuses of user servers at a specified node identifier. When this function terminates normally, it returns the number of user servers whose status is to be acquired.

Arguments whose value is set in the UAP

node_id

Specify the pointer to the node identifier or the character string (*). Add a null character after the node identifier. If the pointer to the character string (*) is specified, the OpenTP1 node which called this function is assumed.

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.

entry_count

Specify the pointer to the area to which the number of user servers will be returned. The area set here will contain the number of user servers at the OpenTP1 node identified by node_id.

flags

Specify DCNOFLAGS.

Return values

Return valueReturn value (numeric)Explanation
DC_OK0Normal termination. The area indicated by entry_count now contains the number of user servers.
DCADMER_PARAM-1852The value specified for the argument is invalid.
DCADMER_COMM-1851Communication 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).
DCADMER_MEMORY-1861The memory became insufficient.
DCADMER_PROTO-1854The function dc_adm_get_sv_status_begin() was already called.
The function dc_rpc_open() was not called.
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_DEF-1862An incorrect value is specified in the multinode configuration definition or in the multinode physical definition.
DCADMER_NODE_NOT_EXIST-1867The node identified by node_id is not included in the OpenTP1 nodes.
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_SWAP-1868The status of the user server cannot be acquired because the system is being switched.