Click or drag to resize

VoDbFieldGet Function

Retrieve the value of a specified database field.

Namespace:  XSharp.RT
Assembly:  XSharp.RT (in XSharp.RT.dll) Version: 2.08
Syntax
 FUNCTION VoDbFieldGet(
	wFieldPos AS DWORD,
	ptrRetVal REF USUAL
) AS LOGIC
View Source

Parameters

wFieldPos
Type: UInt32
The position of the field in the record structure for the current work area.
ptrRetVal
Type: Usual
A pointer to a polymorphic value.  This value will receive the requested information if the function is successful and will be unchanged otherwise.  If you just want to retrieve information, this value must be NIL before calling the function.
Although other RDDs may expand on this concept, the supplied RDDs (as outlined in the "RDD Specifics" appendix in the Programmer's Guide) limit using a non-NIL value to a single circumstance in which you can change the information rather than just retrieve it.  With the DBS_ALIAS <kInfoType>, you can specify a non-NIL value, allowing you to specify a string that you can subsequently use to access the indicated field.

Return Value

Type: Boolean
TRUE if successful; otherwise, FALSE.
Remarks
VODBFieldGet() is like FieldGet() but is strongly typed.  See FieldGet() for more information and an example.
Examples