OpenTP1 Version 7 Programming Reference C Language

[Contents][Index][Back][Next]

dc_adm_get_nd_status_begin - Start acquiring the status of an OpenTP1 node

Format

ANSI C, C++

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

K&R C

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

Description

The function dc_adm_get_nd_status_begin() starts acquiring the status of an OpenTP1 node. When this function terminates normally, it returns the number of OpenTP1 nodes whose status will be acquired.

Arguments whose value is set in the UAP

sub_area

Specify the pointer to the multinode subarea identifier or character string (*). Add a null character after the multinode subarea identifier. If the pointer to the character string (*) is specified, the function will acquire the statuses of all OpenTP1 nodes making up the multinode area.

The length of the multinode subarea identifier must be equal to or less than the maximum length defined by DCADM_SUB_AREA_NAME_SIZE. If a longer identifier is specified, the function returns with an error.

entry_count

Specify the pointer to the area to which the number of OpenTP1 nodes will be returned. The area set here will contain the number of OpenTP1 nodes in the multinode subarea identified by sub_area. If the pointer to the character string (*) is specified for sub_area, the number of all OpenTP1 nodes in the multinode area will returned to the area.

flags

Specify DCNOFLAGS.

Return values

Return value Return value (numeric) Explanation
DC_OK 0 Normal termination. This value is returned even if the specified multinode subarea contains an OpenTP1 involving a communication error.
DCADMER_PARAM -1852 The value specified for the argument is invalid.
DCADMER_SUBAREA_NOT_EXIST -1860 There is no multinode subarea with the name specified for sub_area.
DCADMER_MEMORY -1861 The memory became insufficient.
DCADMER_DEF -1862 An incorrect value is specified in the multinode configuration definition or in the multinode physical definition.
DCADMER_PROTO -1854 The function dc_adm_get_nd_status_begin() was already called.
The function dc_rpc_open() was not called.
DCADMER_MULTI_DEF -1864 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.