SQLSelect.FieldInfo Method | |
Retrieve information about or set an alias for the indicated column.
Namespace:
VO
Assembly:
VOSQLClasses (in VOSQLClasses.dll) Version: 2.21
Syntax VIRTUAL METHOD FieldInfo(
kFieldInfoType,
uFieldPos,
uFieldVal
) AS USUAL CLIPPER
[ClipperCallingConventionAttribute(new string[] { ... })]
public virtual Usual FieldInfo(
Usual kFieldInfoType = default,
Usual uFieldPos = default,
Usual uFieldVal = default
)
Request Example
View SourceParameters
- kFieldInfoType (Optional)
- Type: Usual
The type of information, as specified by the following constants:
- uFieldPos (Optional)
- Type: Usual
The name, number, or symbol representing the desired column. - uFieldVal (Optional)
- Type: Usual
The alias name to be assigned to the column. This argument is only used if DB_ALIAS is specified for kColumnInfoType.
Return Value
Type:
Usual
A value (whose data type depends on the value requested) if successful; otherwise, NIL.
Remarks Constant | Description |
---|
DBS_ALIAS | Alternate name (or alias) by which a column can be referenced |
DBS_DEC | Number of decimal places |
DBS_LEN | Length (field size) as a number |
DBS_NAME | Field name as a string |
DBS_TYPE | Data type as a string |
The SQLSelect:FieldInfo() method is used to retrieve information about a column, except if you specify
kColumnInfoType to be DBS_ALIAS. You can then specify an alias for a column, which you can access by using the SQLColumn:AliasName property.
See Also