LAPI_Term Subroutine

Purpose

Terminates and cleans up a LAPI context.

Library

Availability Library (liblapi_r.a)

C Syntax

#include <lapi.h>
 
int LAPI_Term(hndl)
lapi_handle_t hndl;

FORTRAN Syntax

include 'lapif.h'
 
LAPI_TERM(hndl, ierror)
INTEGER hndl
INTEGER ierror

Description

Type of call: local termination

Use this subroutine to terminate the LAPI context that is specified by hndl. Any LAPI notification threads that are associated with this context are terminated. An error occurs when any LAPI calls are made using hndl after LAPI_Term is called.

A DGSP that is registered under that LAPI handle remains valid even after LAPI_Term is called on hndl.

Parameters

INPUT
hndl: Specifies the LAPI handle.
OUTPUT
ierror: Specifies a FORTRAN return code. This is always the last parameter.

Restrictions

LAPI statistics are not reported for shared memory communication and data transfer, or for messages that a task sends to itself.

C Examples

To terminate a LAPI context (represented by hndl):

LAPI_Term(hndl);

Return Values

LAPI_SUCCESS: Indicates that the function call completed successfully.
LAPI_ERR_HNDL_INVALID: Indicates that the hndl passed in is not valid (not initialized or in terminated state).

Location

/usr/lib/liblapi_r.a