Administrative API Reference

sqlgdref - Dereference Address

Copies data from a buffer that is defined by a pointer, into a variable that is directly accessible by the application. It is used in host languages, such as FORTRAN and COBOL, that do not provide pointer manipulation. This API can be used to obtain results from APIs, such as sqlengne - Get Next Node Directory Entry, that return a pointer to the desired data.

Authorization

None

Required Connection

None

Version

sqlutil.h

Generic API Syntax

/* File: sqlutil.h */ /* API: Dereference Address */ /* ... */ SQL_API_RC SQL_API_FN sqlgdref ( unsigned int NumBytes, char * pTargetBuffer, char ** ppSourceBuffer); /* ... */

API Parameters

NumBytes

Input. An integer representing the number of bytes to be transferred.

pTargetBuffer

Output. Area into which the data are moved.

ppSourceBuffer

Input. A pointer to the area containing the desired data.

Usage Notes

This API is used in the COBOL and FORTRAN languages only.

See Also

sqlgaddr - Get Address.