Group Services Programming Guide and Reference

ha_gs_get_ffdc_id subroutine

Purpose

ha_gs_get_ffdc_id - Retrieve an FFDC ID that is associated with a Group Services subsystem failure

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_ffdc_id(fc_eid_t fid)
               

Parameters

fid

A pointer to the FFDC ID that will be copied from the GSAPI.

Description

The ha_gs_get_ffdc_id() subroutine is provided to retrieve a First Failure Data Capture (FFDC) identifier that can help determine the root cause of a Group Services subsystem failure. The FFDC ID is reset if ha_gs_init is called again. For further details on FFDC, see the FFDC Programmers Guide and Reference.

Restrictions

In certain situations, this function may not provide an FFDC ID even if the Group Services subsystem fails.

Return Values

HA_GS_NOT_OK-- GSAPI did not receive an FFDC ID from the Group Services subsystem.

HA_GS_OK-- GSAPI received an FFDC ID from the Group Services subsystem.

Asynchronous Errors

None.

Files

ha_gs.h

Prerequisite Information

Understanding Group Services.

Related Information

Subroutines: ha_gs_init, ha_gs_dispatch.