CommonSingleMethods Class Reference

This class contains methods which are inherited by other config classes. More...

Inheritance diagram for CommonSingleMethods:

Collaboration diagram for CommonSingleMethods:

Static Public Member Functions
_.Library.Status	Get (_.Library.String Properties, _.Library.String CPFFile, _.Library.Integer Flags)
	Get a sections properties from a CPF file. More...
_.Library.Status	GetList (_.Library.String CPFFile, _.Library.Integer Flags)
	Returns the properties from a section in a CPF file by value in $list format More...
_.Library.Status	Modify (_.Library.String Properties, _.Library.String CPFFile, _.Library.Integer Flags)
	Modify a sections properties in a CPF file. More...
_.Library.ObjectHandle	Open (_.Library.String CPFFile, _.Library.Integer concurrency, _.Library.Status Status, _.Library.Integer Flags)
	Open an instance of an section object in a CPF file. More...

Detailed Description

This class contains methods which are inherited by other config classes.

Member Function Documentation

Get()

_.Library.Status Get ( _.Library.String  Properties, _.Library.String  CPFFile, _.Library.Integer  Flags  )

static

Get a sections properties from a CPF file.

Parameters:
CPFFile (byref) - Name of the CPF file to use, Default=current active CPF file. The file must have a .CPF file extension if specified.

Return values:
Properties (byref) - List of the properties in Properties(Name)=Value format. See the subclass for a list of valid properties.
CPFFile (byref) - Name of the CPF file the modification was made in.

GetList()

_.Library.Status GetList ( _.Library.String  CPFFile, _.Library.Integer  Flags  )

static

Returns the properties from a section in a CPF file by value in $list format

Parameters:
CPFFile (byref) - Name of the CPF file to use, Default=current active CPF file. The file must have a .CPF file extension if specified.

Return value:
&nbsp&nbsp&nbsp&nbsp&nbsp $lb(Status,Result)
&nbsp&nbsp&nbsp&nbsp&nbsp where Result=$LB($LB(property name,value),...) for each property in the section

Modify()

_.Library.Status Modify ( _.Library.String  Properties, _.Library.String  CPFFile, _.Library.Integer  Flags  )

static

Modify a sections properties in a CPF file.

Parameters:
Properties (byref) - List of the properties to modify in Properties(Name)=Value format. See the subclass for a list of valid properties. If a specific property is not passed in the properties array, the value is not modified.
CPFFile (byref) - Name of the CPF file to use, Default=current active CPF file. The file must have a .CPF file extension if specified.
Flags - Bit string of options to perform if the object is later saved with the Save() method. See the <METHOD>Open</METHOD> method for values.

Return values:
CPFFile (byref) - Name of the CPF file the modification was made in.

Reimplemented in config.

Open()

_.Library.ObjectHandle Open ( _.Library.String  CPFFile, _.Library.Integer  concurrency, _.Library.Status  Status, _.Library.Integer  Flags  )

static

Open an instance of an section object in a CPF file.

Parameters:
CPFFile (byref) - Name of the CPF file to use, Default=current active CPF file. The file must have a .CPF file extension if specified.
Flags - (From syConfig.inc) Bit string of options to perform if the object is later saved with the Save() method.
Bit $$$CPFSave - Save - Save data to config database.
Bit $$$CPFWrite - Write - Write config database to CPF file.
Bit $$$CPFActivate - Activate - Copy changes to ^CONFIG global, and make active on system.
By default, all these bits are set, and you should normally not pass this parameter. If you are modifying a CPF file which is not the active CPF file, Bit $$$CPFActivate is ignored.


Return Values:
CPFFile (byref) - Name of the CPF file the modification was made in.