The SM2GMS macro

The SM2GMS macro (SM2 Get Measurement Status) supplies all the data of the MEASUREMENT STATUS screen.

The macro stores the data in a C structure of the type
SM2GMS_get_measurement_status_mdl. This structure is defined by the caller and must be passed as a parameter when the macro is called.

-----------------------------------------------------------------------------
#include "FHDR.H"
#include "SM2GMS.H"
#include "SM2RC.H"
SM2GMS( struct SM2GMS_get_measurement_stat_mdl SM2_STATUS, char *host_name );
-----------------------------------------------------------------------------

struct SM2 GMS_get_measurement_stat_mdl SM2_STATUS;

This structure must be defined before the macro is called. The macro stores the return codes and the data of the MEASUREMENT STATUS screen in this structure.

There is a description of the structure in section "Structures of the SM2GMS macro".

char *host_name

This parameter, which supports a host network, can be used to call the SM2 data of those hosts to which a connection exists through the MSCF subsystem.

However, this is dependent on the following conditions:

• the MSCF connection type must be CCS and the MSCF partner type must be CCS or XCS

• the SM2 subsystem must be loaded on the remote host

• the SM2 version on the remote host must be higher than or the same as that of the SM2GMS version of the local machine.

The parameter specifies the address of the field which contains the name of the host.If the SM2 data of a remote host is to be called, the host name of that host must be specified in the field in 8 characters (see the “HIPLEX MSCF” manual [8 (Related publications)]).
If the SM2 data of the local host is to be called, the 8-byte field is to be initialized with zero (binary) or a blank.

Return code

• The return codes are stored in the standard header.
• The standard header is a structure of the type ESMFHDR. It can be addressed by means of the “hdr” structure element of the SM2_STATUS structure.
• The evaluation of the return codes is described in section "Evaluating the return codes".

Notes

• SM2GMS is implemented as a macro.
• When using the macro, the ISM2CALL module from the SYSLIB.SM2.<ver> library must be linked to the program(for native code on x86 servers: SKULIB.SM2.<ver>).

• SM2GMS.H is in the SYSLIB.SM2.<ver> library and can be printed out with the following command:

  /PRINT-DOCUMENT 
     FROM-FILE=*LIBRARY-ELEMENT(
        LIBRARY=SYSLIB.SM2.<ver>,
        ELEMENT=SM2GMS.H,TYPE=S)
  

• There is an example of the use of this macro in section "Example".