17.20 - File Get Position - Access Module

Teradata® Tools and Utilities Access Module Programmer Guide

Product
Access Module
Release Number
17.20
Published
June 2022
Language
English (United States)
Last Update
2022-06-21
dita:mapPath
epi1641303181955.ditamap
dita:ditavalPath
obe1474387269547.ditaval

The File Get Position function determines and returns the media position of an open file. The structure follows:

typedef struct _pmPosData
(
  pmUInt32       Length;
  char          *Data;
} pmPos_t;
typedef struct _pmiPos
{
  char       EyeCatcher[pmiMAX_EC_LEN];/* Struct eyecatcher string */
  pmUInt32   StructLength;             /* Length of this structure */
  void      *FIData;
  pmPos_t    Position;
} pmiPos_t;

where the following is true:

Parameter Field Description
EyeCatcher input Structure description string, such as pmGetParms.
StructLength input Total structure length, including the EyeCatcher string.
FIData input Value provided by the Access Module in response to a previous open request call.
Position output A two-field structure as follows:
  • Length – The length, in bytes, of the Data field
  • Data – A pointer to the media position information

Usage Notes

Consider the following when specifying File Get Position parameters:
  • Requirements – A File Get Position function is required when the Reqtype field of the pmiCmdBlock_t structure is pmiPIDMOptGetPos.
  • Position Data Length – Always minimize the length of the position data stored in the Length field of the pmPos_t structure, as certain arbitrary limits can be encountered.