Xbasic

SQL::Argument Class

IN THIS PAGE

Properties
- Name
- Data
- Usage
- XML
- IsNull

Description

SQL::Argument Class properties and an example.

The SQL::Argument object defines a single argument to be passed to a SQL method in a SQL::Arguments collection.

Example

dim args as SQL::Arguments
dim arg as SQL::Argument
arg.data = "VT"
arg.Name = "State"
? args.add(arg)
= .T.
? args.find(arg.name)
= Data = "VT"
Name = "State"
Usage = 0

Properties

NameCharacter

The unique name of the argument. Note: An argument name cannot be changed while it is part of a collection.

DataAny Type

The value in the argument. The type of this argument will be one of the Alpha Anywhere primitive types listed below:

Type: Description
B: blob
C: character
D: date
L: logical
N: numeric
T: time
Y: short time

UsageSQL::ArgumentUsage

Defines when to set the value of an argument.

XMLCharacter

An XML string that contains the argument definition.

IsNullLogical

Indicates whether or not the argument is NULL. If .t., the argument will be treated as a "NULL" value in the system of record. If .f., the argument's value will be treated as a literal value.