SIMPOL Documentation

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

PropertyTypeDescription
SBLdisplayformatstring 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.
datatypetype Specifies the type object which represents the type of the data associated with the field in the SBME database file.
fieldnamestring Gives the name of the field as recorded in the SBME database file.
nextppcstype1serverfield Gives the next ppcstype1serverfield object for the same table.
shareableboolean 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.
sharenamestring Gives the field name which PPCS clients must use. By default, this is the same as the name recorded in the SBME database file.
sharetypestring

Indicates the SBL data type which the client should assume for the field. sharetype must be one of the following values.

'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

tableppcstype1servertable Specifies the table to which the field belongs.
typetype Specifies the ppcstype1serverfield type object.

Methods

setshareability()

Description

Determines the sharing characteristics of a field.

Prototype

ppcstype1serverfieldvar.setshareability ( boolean shareable, string sharename, string sharetype, string SBLdisplayformat )

Parameters
ParameterDefault valueType nameDescription
shareableThe current value of the shareable propertyboolean Determines whether or not the field can be accessed by PPCS clients, i.e. whether or not it is shared via PPCS.
sharenameThe current value of the sharename propertystring Determines the name by which the field is accessed by PPCS clients.
sharetypeThe current value of the sharetype propertystring

Indicates the SBL data type which the client should assume for the field. sharetype must be one of the following values.

'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

SBLdisplayformatThe current value of the SBLdisplayformat propertystring The format string which SBL applications should use for the data from the field.