CHECKPROP
9.0, PLBCMP GUI Only
The CHECKPROP instruction tests whether a property is valid for a specified GUI object. The instruction uses the following format:
|
|
|
|
|
|
|
|
|
|
Where:
label
Optional. A Program Execution Label.
object
Required. An OBJECT or decimal number indicating the object that is checked.
sep
Required. A comma or one of the following prepositions: BY, TO, OF, FROM, USING, WITH, IN, or INTO.
property
Required. A previously defined Character String Variable or literal defining the property that is checked.
type
Optional. A previously defined Numeric Variable or decimal number that restricts the property search.
mask
Optional. A previously defined Numeric Variable that returns the property instruction definition.
Flags Affected: OVER, ZERO
Note the following:
{object} identifies the object or object type for which the property is checked. If {object} is a decimal number or numeric variable, the value must be a Sunbelt object type as defined in the TYPE instruction or a sub-type object value as defined in the PLBEQU.INC include file.
The {property} parameter is not case sensitive and its logical string specifies the property that is checked. Any trailing blank characters in the logical string are ignored.
If the TYPE keyword is specified, the value identifies the instruction restriction that is applied for the property search. If this parameter is not specified or not within the range of zero through three inclusive, a value of zero is assumed. Valid values are:
|
Value |
Determine whether the property exists for --- |
|
0 |
any instruction. |
|
1 |
the CREATE instruction. |
|
2 |
the GETPROP instruction. |
|
3 |
the SETPROP instruction. |
When the MASK keyword is specified, the {mask} variable receives a bit mask that identifies the instructions in which the property is available. The returned binary bit mask value can be a combination of any of the following values:
|
Value |
The property is valid for ... |
|
0x1 |
CREATE statements. |
|
0x2 |
SETPROP statements. |
|
0x4 |
GETPROP statements. |
The ZERO flag is set when the property is found and it is valid for the instruction TYPE being checked.
The OVER flag is set TRUE if any returned value is too large for a returned variable and must be truncated.
See Also: Object Definitions, Properties, Object Instructions
|
|