SEND_MDS_MU

This verb is used by a MDS-level application to send network management data other than alerts using the WinMS entry point. If an error occurs during the sending of the MDS_MU to the destination application, the error is reported back to the origin application in one of two ways. If the error is detected at the local node, the application will be notified via the return codes of the SEND_MDS_MU response. If the error is detected at a remote node, the error is reported by means of an error MDS_MU transported in an MDS_MU_RECEIVED VCB. Management services can convert the outgoing MDS_MU to an NMVT if the destination node is to be reached via an SSCP-PU session. The application does not need to know the identity of its local node. If the application supplies 8 EBCDIC blanks in the netid or nau or both subfields of the origin location name subvector of the MDS Routing Information GDS variable, Personal Communications or Communications Server will supply the appropriate values. If an application does not fill in either the netid or nau but supplies fewer than 8 blanks, Personal Communications or Communications Server will return a secondary return code of AP_INVALID_MDS_MU_FORMAT.

VCB Structure

typedef struct ms_send_mds_mu
{
   unsigned short   opcode;             /* Verb operation code         */
   unsigned char    reserv2;            /* reserved                    */
   unsigned char    format;             /* format                      */
   unsigned short   primary_rc;         /* Primary return code         */
   unsigned long    secondary_rc;       /* Secondary return code       */
   unsigned char    options;            /* Verb options                */
   unsigned char    reserv3;            /* reserved                    */
   unsigned char    originator_id[8];   /* Originator ID               */
   unsigned char    pu_name[8];         /* Physical unit name          */
   unsigned char    reserv4[4];         /* reserved                    */
   unsigned short   dlen;               /* Length of data              */
   unsigned char    *dptr;              /* Data                        */
} MS_SEND_MDS_MU;

Supplied Parameters

opcode
AP_SEND_MDS_MU
format
Identifies the format of the VCB. Set this field to zero to specify the version of the VCB listed above.
options
Specifies optional processing on the data supplied on this verb. This parameter is a one-byte value, with individual bit settings indicating the options selected. If all options are specified, set this byte to zero.
  • Bit 0 is the most significant, and bit 7 is the least significant bit.
  • Bit 0: Adds Date/Time (X'01') subvector to the data if set to zero.
  • Bit 1: Adds Product Set ID (X'10') subvector to the data if set to zero. If the application supplies data that already contains a Product Set ID subvector, then management services adds Personal Communications or Communications Server's Product Set ID subvector immediately before the existing one.
  • Bit 2: reserved.
  • Bit 3: Logs the data via the Personal Communications or Communications Server problem determination facility if set to zero.
    Note:
    The following constants are provided in the management services header file that refer to bits 0, 1, and 3 specified above.
    • SV_TIME_STAMP_SUBVECTOR
    • SV_PRODUCT_SET_ID_SUBVECTOR
    • SV_LOCAL_LOGGING
  • Bit 4: Specifies whether management services is to use default or direct routing to send the management services data to the destination application (AP_DEFAULT or AP_DIRECT).
    Note:
    To set bit 4, use AP_DEFAULT or AP_DIRECT shifted appropriately (for example, AP_DIRECT<<3).
  • Bits 5–7: reserved.
originator_id
Name of component that issued the verb. This field is only used by management services when logging the SEND_MDS_MU.
pu_name
Name of the physical unit to send the data to. This should be set to either an 8-byte alphanumeric type-A EBCDIC string, padded to the right with EBCDIC spaces, or set to all binary zeros if no pu_name is specified. Applications using SEND_MDS_MU to respond to MDS_MU_RECEIVED indications that were converted from incoming NMVTs should specify the pu_name received in the MDS_MU_RECEIVED signal. MDS_MUs that are to be transported using the MDS transport facility should set the pu_name to all binary zeros.
dlen
Length of data.
dptr
Pointer to data. If this is set to NULL, management services assumes that the data is contiguous with (and begins immediately following) the VCB.

Returned Parameters

If the verb executes successfully, the Program management services returns the following parameter:
primary_rc
AP_OK
If the verb fails to execute because of a parameter error, the Program management services returns the following parameters:
primary_rc
AP_PARAMETER_CHECK
secondary_rc
AP_INVALID_PU_NAME

AP_INVALID_MDS_MU_FORMAT
SV_INVALID_DATA_SIZE

If the verb fails to execute because of a state error, the Program management services returns the following parameters:
primary_rc
AP_STATE_CHECK
secondary_rc
AP_SSCP_PU_SESSION_NOT_ACTIVE
If the verb does not execute because of a system error, the Program management services returns the following parameter:
primary_rc
AP_UNEXPECTED_SYSTEM_ERROR