NAME

arm_end - finish ARM activity.

SYNOPSIS

error_status=arm_end(appl_id,flags,data,data_size)

DESCRIPTION

Function arm_end() is used to close initiating new ARM API activity. It is typically called when an application/user instance is terminating. Each arm_end() is paired with one arm_init() to mark the end of an application.

An arm_end() is a signal from the application that it does not intend to issue any more arm_getid() calls using this appl_id, or any arm_start() calls using any TRAN_ID defined using this appl_id. After arm_end(), the measurement agent may ignore any arm_getid() or arm_start() calls. It is acceptable to call arm_update() or arm_stop() for any incomplete transaction instances started with arm_start().

PARAMETERS

appl_id (int32)

A unique reference to an application/user identifier returned from the arm_init() call. If appl_id is less than zero, this arm_end() call will be treated as a NULL operation, and a negative error_status returned.

flags (int32)=0

Reserved for future use. It must be set to zero.

data (char*)=0

Reserved for future use. A NULL pointer (0) must be used.

data_size (int32)=0

Reserved for future use. It must be set to zero.

RETURN CODE

ERROR_STATUS

Contains a zero if successful and a negative value if an error occurred.

ERRORS

If the value returned in ERROR_STATUS is less than zero, an error occurred in communicating with the measurement agent. The most likely cause is passing an invalid value for appl_id. The error should be logged so that corrective action can be taken.

EXAMPLE

status = arm_end (my_appl_id,  /* transaction handle */
           0,0,0);             /* reserved for future use */