Shutdown - Access Module

Teradata Tools and Utilities Access Modules Programmer Guide

Product
Access Module
Release Number
15.10
Language
English (United States)
Last Update
2018-10-07
dita:id
B035-2424
lifecycle
previous
Product Category
Teradata Tools and Utilities

The Shutdown function terminates an Access Module. The structure follows:

 
typedef struct _pmiShut                                              
{                                                             
  char       EyeCatcher[pmiMAX_EC_LEN];/* Struct eyecatcher string */
  pmUInt32   StructLength;             /* Length of this structure */
  void      *PIData;                                                 
  pmUInt16   Mode;                                                   
} pmiShut_t;                                                         

where:

 

Parameter

Field

Description

EyeCatcher

input

Structure description string, such as pmShutParms.

StructLength

input

Total structure length, including the EyeCatcher string.

PIData

input

Value provided by an Access Module in response to a previous open request call.

Mode

input

Shutdown mode/option as follows:

  • pmShutDownNormal Normal error checking. If anything prevents a clean termination (such as files still open), then exit without action with a non‑pmrcOK in Retcode.
  • pmShutDownBrute – Take arbitrary action for unexpected conditions.