Group Services Programming Guide and Reference

ha_gs_get_node_number subroutine

Purpose

ha_gs_get_node_number - Get the local node number.

Library

GSAPI Thread-Safe Library (libha_gs_r.a)

GSAPI Library (not thread-safe) (libha_gs.a)

Syntax

#include <ha_gs.h>
 
ha_gs_rc_t ha_gs_get_node_number( int *node_number )

Parameters

node_number

An output parameter which is a pointer to an integer which is the local node number returned from this function call.

Description

This function gives the local node number. When this function is called, the Group Services library will send back the local node number to the caller through the node_number parameter.

Return Values

HA_GS_OK-- The function call is successful.

HA_GS_NOT_OK-- The GS library is not initialized successfully, or the local node number is not yet obtained from the Group Services. If the user inputs a NULL pointer for the parameter node_number, the function also returns HA_GS_NOT_OK.

HA_GS_NO_INIT-- The GS library is not initialized yet. The user must call ha_gs_init() first.

Asynchronous Errors

None.

Files

ha_gs.h

Prerequisite Information

Understanding Group Services.

Related Information

Subroutines: ha_gs_init, ha_gs_get_adapter_info.