KCML_Map_DeclarePtr

Purpose

Map a pointer returned by $DECLARE to a structure or string variable

Definition

DEFSUB 'KCML_Map_DeclarePtr(BYREF x$, DeclarePtr, Flags = MAPFILE_READONLY) AS Void

Parameters

x	Name of string variable to be mapped
DeclarePtr	Pointer returned from $DECLARE operation
Flags	Optional. Any MAPFILE_ constant

Description

The 'KCML_Map_DeclarePtr function maps the result of a pointer from a $DECLARE to a string variable representing a structure or nul-terminated string. The mapping is directly on to the pointer with no memory being copied. For structures the size of the string variable is not modified, but for nul-terminated strings the flag _MAPFILE_STRING can be used to make the lenfgth be the lenght of the string up to the nul termninator.

See also

Internal KCML Functions, Internally defined structures and Internally defined enumerations and constants.