Click or drag to resize

FieldSym Function (UInt32, Usual)

Return the name of a field as a symbol.

Namespace:  XSharp.RT
Assembly:  XSharp.RT (in XSharp.RT.dll) Version: 2.4a
Syntax
 FUNCTION FieldSym(
	dwFieldPos AS DWORD,
	uArea AS USUAL
) AS SYMBOL
View Source

Parameters

dwFieldPos
Type: UInt32
The position of the field in the database file structure.
uArea
Type: Usual
Specifies the work area name or number for a table from which the value must be retrieved.

Return Value

Type: Symbol
The name of the specified field as a symbol.
If <dwFieldPos> does not correspond to an existing field in a database file or if no database file is open, FieldSym() returns NULL_SYMBOL.
Remarks
FieldSym() returns a field name as a symbol, using an index to the position of the field name in the database structure.
Use it in data-independent applications where the field name is unknown.
If information for more than one field is required, use DBStruct(). If you need additional database file structure information, use Type() and Len().
For example, to obtain the number of decimal places for a numeric field, use the following expression:
X#
1Len(Substr(Str(<idField>), RAt(".", Str(<idField>)) + 1))
By default, this function operates on the currently selected work area.   It can be made to operate on an unselected work area by specifying it within an aliased expression or by calling the that accepts a workarea parameter (a workarea number or alias ).
Examples
These examples illustrate FieldSym() used with several other functions:
X#
1USE sales
2QOut(FieldSym(1))                // Result: BRANCH
3QOut(FCount())                    // Result: 5
4QOut(LEN(FieldSym(0)))            // Result: 0
5QOut(LEN(FieldSym(40)))            // Result: 0
This example uses FieldSym() to list the name and type of each field in CUSTOMER.DBF:
X#
1USE customer NEW
2FOR nField := 1 UPTO FCount()
3    QOut(PadR(FieldSym(nField), 10),;
4            VALTYPE(&(FieldSym(nField))))
5NEXT
This example accesses fields in unselected work areas using aliased expressions:
X#
1USE sales NEW
2USE customer NEW
3USE invoices NEW
4QOut(Sales->FieldSym(1))            // Result: Salenum
5QOut(Customer->FieldSym(1))        // Result: Custnum
See Also