LAPI_Getcntr Subroutine

Purpose

Gets the integer value of a specified LAPI counter.

Library

Availability Library (liblapi_r.a)

C Syntax

#include <lapi.h>
 
int LAPI_Getcntr(hndl, cntr, val)
lapi_handle_t  hndl;
lapi_cntr_t   *cntr;
int           *val;

FORTRAN Syntax

include 'lapif.h'
 
LAPI_GETCNTR(hndl, cntr, val,  ierror)
INTEGER hndl
TYPE (LAPI_CNTR_T) :: cntr
INTEGER val
INTEGER ierror

Description

Type of call: Local counter manipulation

This subroutine gets the integer value of cntr. It is used to check progress on hndl.

Parameters

INPUT

hndl

Specifies the LAPI handle.

cntr

Specifies the address of the counter. The value of this parameter cannot be NULL (in C) or LAPI_ADDR_NULL (in FORTRAN).

OUTPUT

val

Returns the integer value of the counter cntr. The value of this parameter cannot be NULL (in C) or LAPI_ADDR_NULL (in FORTRAN).

ierror

Specifies a FORTRAN return code. This is always the last parameter.

C Examples

{
    lapi_cntr_t cntr;
    int         val;

   /* cntr is initialized */

   /* processing/communication takes place */
   
   LAPI_Getcntr(hndl, &cntr, &val)
       
   /* val now contains the current value of cntr */
}

Return Values

LAPI_SUCCESS

Indicates that the function call completed successfully.

LAPI_ERR_CNTR_NULL

Indicates that the cntr pointer is NULL (in C) or that the value of cntr is LAPI_ADDR_NULL (in FORTRAN).

LAPI_ERR_HNDL_INVALID

Indicates that the hndl passed in is not valid (not initialized or in terminated state).

LAPI_ERR_RET_PTR_NULL

Indicates that the value of the val pointer is NULL (in C) or that the value of val is LAPI_ADDR_NULL (in FORTRAN).

Location

/usr/lib/liblapi_r.a