arm_update Subroutine

This subroutine is part of the implementation of the ARM API in the Performance Toolbox for AIX® licensed product. It is implemented as a NULL subroutine call.

Purpose

The arm_update subroutine is used to collect information about a transaction's progress. It is a no-operation subroutine in the PTX implementation.

Library

ARM Library (libarm.a).

Syntax

#include arm.h

arm_ret_stat_t arm_update(  arm_start_handle_t arm_handle, /* unique transaction handle
*/
       arm_flag_t         flags,      /* Reserved = 0                */
       arm_data_t         *data,      /* Reserved = NULL             */
       arm_data_sz_t      data_size); /* Reserved = 0                */

Description

The arm_update subroutine is implemented as a no-operation in the PTX version of the ARM API. It is intended to be used for providing status information for a long-running transaction. Because there's no feasible way to display such information in current PTX monitors, the subroutine is a NULL function.

Parameters

start_handle

The identifier is returned by an earlier call to arm_start, arm_start Subroutine. The start_handle argument is used to look for the slot structure created by the arm_start subroutine call. If one is not found, no action is taken and the function returns -1. Otherwise a zero is returned.

In compliance with the ARM API specifications, if the start_handle passed is one returned from a previous arm_start subroutine call that failed, or from an arm_start subroutine operating as a no-operation function, the arm_update subroutine call executes as a no-operation function. It will return a zero to indicate successful completion.

flags, data, data_size

In the current API definition, the last three arguments are for future use and they are ignored in the implementation.

Return Values

If successful, the subroutine returns zero. If the subroutine fails, a value less than zero is returned.

Error Codes

No error codes are defined by the PTX implementation of the ARM API.

Files