pfm_$signal Library Routine (NCS)

Purpose

Signals the calling process.

Syntax

#include <idl/c/base.h>
#include <idl/c/pfm.h>

void pfm_$signal ( fault_signal) status_$t *fault_signal;

Description

The pfm_$signal routine signals the fault specified by the fault_signal parameter to the calling process. It is usually called to leave cleanup handlers.

Note: This routine does not return when successful.

Parameters

Input

Item	Description
fault_ signal	Indicates a fault code.

Examples

To send the calling process a fault signal, enter:

pfm_$signal(fst);

where fst is a valid PFM fault.