ppcstype1serverfield
Description
A ppcstype1serverfield object represents a field (sometimes called a 'column') in a table from an SBME database.
Type Tags
None
Object Value
Properties
Property | Type | Description |
---|---|---|
SBLdisplayformat | string | The format string which SBL applications should use for the data from the field. |
_ | type(*) | This property is provided for use by the user to attach any object of any type to the type in which this property is provided. |
__ | type(*) | This property is provided for use by the user to attach any object of any type to the type in which this property is provided. It has the additional feature of being marked with the resolve keyword, so that object resolution can continue down this property. |
datatype | type | Specifies the type object which represents the type of the data associated with the field in the SBME database file. |
fieldname | string | Gives the name of the field as recorded in the SBME database file. |
next | ppcstype1serverfield | Gives the next ppcstype1serverfield object for the same table. |
shareable | boolean | Indicates whether or not the field will be included when clients access the table, i.e. whether or not it is shared via PPCS. By default, fields in a table ARE shareable. |
sharename | string | Gives the field name which PPCS clients must use. By default, this is the same as the name recorded in the SBME database file. |
sharetype | string |
Indicates the SBL data type which the client should assume for the
field. 'txt' - text data
'log' - single character text data indicating 'true' or 'false'
'num' - decimal numeric data
'nml' - integer numeric data between -2G and +2G
'nmi' - integer numeric data between -32k and +32k
'dat' - a date
'tim' - a time |
table | ppcstype1servertable | Specifies the table to which the field belongs. |
type | type | Specifies the ppcstype1serverfield type object. |
Methods
setshareability()
Description
Determines the sharing characteristics of a field.
Prototype
ppcstype1serverfieldvar
.setshareability
(
boolean
,
string shareable
,
string sharename
,
string sharetype
)
SBLdisplayformat
Parameters
Parameter | Default value | Type name | Description |
---|---|---|---|
shareable | The current value of the shareable property | boolean | Determines whether or not the field can be accessed by PPCS clients, i.e. whether or not it is shared via PPCS. |
sharename | The current value of the sharename property | string | Determines the name by which the field is accessed by PPCS clients. |
sharetype | The current value of the sharetype property | string |
Indicates the SBL data type which the client should assume for the
field. 'txt' - text data
'log' - single character text data indicating 'true' or 'false'
'num' - decimal numeric data
'nml' - integer numeric data between -2G and +2G
'nmi' - integer numeric data between -32k and +32k
'dat' - a date
'tim' - a time |
SBLdisplayformat | The current value of the SBLdisplayformat
property | string | The format string which SBL applications should use for the data from the field. |