Previous Page Contents Page Next Page

3.8 UNREGISTER_NMVT_APPLICATION

The UNREGISTER_NMVT_APPLICATION verb indicates to SNAP-IX that this application, which previously registered to receive NMVTs for a given application name, no longer wants to receive them for that name.

If the application used the same application name in multiple REGISTER_NMVT_APPLICATION verbs to accept different types of NMVTs, unregistering this name means that the application no longer receives any of these NMVTs. However, if the application registered using more than one name, it continues to receive NMVTs of the types specified for any remaining application names.

Before terminating, an application should always issue UNREGISTER_NMVT_APPLICATION for all its registered application names, followed by DISCONNECT_MS_NODE.

3.8.1 VCB Structure

typedef struct unregister_nmvt_application
{
   AP_UINT16       opcode;            /* Verb operation code                  */
   unsigned char   reserv2;           /* reserved                             */
   unsigned char   format;            /* reserved                             */
   AP_UINT16       primary_rc;        /* Primary return code                  */
   AP_UINT32       secondary_rc;      /* Secondary return code                */
   unsigned char   ms_appl_name[8];   /* MS application name                  */
} UNREGISTER_NMVT_APPLICATION; 

3.8.2 Supplied Parameters

An application supplies the following parameters when it issues UNREGISTER_NMVT_APPLICATION:

opcode

AP_UNREGISTER_NMVT_APPLICATION

ms_appl_name

The name identifying the application that is unregistering. This must be a name that the application has previously specified using REGISTER_NMVT_APPLICATION. The string must be eight characters long; pad on the right with EBCDIC space characters (0x40) if necessary.

3.8.3 Returned Parameters

After the verb executes, SNAP-IX returns parameters to indicate whether the execution was successful and, if not, to indicate the reason the execution was not successful.

Successful Execution

If the verb executes successfully, SNAP-IX returns the following parameter:

primary_rc

AP_OK

SNAP-IX does not return a secondary_rc when the verb executes successfully.

Parameter Check

If the verb does not execute because of a parameter error, SNAP-IX returns the following parameters:

primary_rc

AP_PARAMETER_CHECK

secondary_rc

One of the following:

AP_APPL_NOT_REGISTERED

The application has not previously issued REGISTER_NMVT_APPLICATION with the application name specified on this verb.

AP_INVALID_TARGET_HANDLE

The supplied target handle was not a valid value returned on a previous CONNECT_MS_NODE verb.

State Check

If the verb fails to execute because of a state error, SNAP-IX returns the following parameters:

primary_rc

AP_STATE_CHECK

secondary_rc

One of the following:

AP_INVALID_TARGET_STATE

The application issued this verb while CONNECT_MS_NODE or DISCONNECT_MS_NODE was outstanding.

AP_SYNC_PENDING

This verb was issued using the synchronous entry point, but another synchronous verb was in progress for this target handle. Only one synchronous verb can be in progress on a particular target handle at any time.

AP_SYNC_NOT_ALLOWED

The application used the synchronous MS entry point to issue this verb within a callback routine. The application must use the asynchronous entry point to issue any verb from a callback routine.

SNAP-IX Software Not Active

If the verb does not execute because the SNAP-IX software is not active, SNAP-IX returns the following parameter:

primary_rc

AP_COMM_SUBSYSTEM_ABENDED

The SNAP-IX software has failed.

SNAP-IX does not return a secondary_rc when the SNAP-IX software is not active.

System Error

If the verb does not execute because of a system error, SNAP-IX returns the following parameters:

primary_rc

AP_UNEXPECTED_SYSTEM_ERROR

An operating system call failed during processing of the verb.

secondary_rc

The return code from the operating system call. For the meaning of this return code, check the returned value in the file /usr/include/sys/errno.h .

Previous Page Contents Page Top of Page Next page