CommonMultipleMethods Class Reference

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

Inheritance diagram for CommonMultipleMethods:

Collaboration diagram for CommonMultipleMethods:

Static Public Member Functions
_.Library.Status	Create (_.Library.String Name, _.Library.String Properties, _.Library.String CPFFile, _.Library.Integer Flags)
	Create a section instance in a CPF file. More...
_.Library.Status	Delete (_.Library.String Name, _.Library.String CPFFile, _.Library.Integer Flags)
	Delete a section instance from a CPF file. More...
_.Library.Boolean	Exists (_.Library.String Name, _.Library.ObjectHandle Obj, _.Library.Status Status, _.Library.String CPFFile, _.Library.Integer Flags)
	Database exists. More...
_.Library.Status	Get (_.Library.String Name, _.Library.String Properties, _.Library.String CPFFile, _.Library.Integer Flags)
	Get a section instances properties from a CPF file. More...
_.Library.Status	GetList (_.Library.String Name, _.Library.String CPFFile, _.Library.Integer Flags)
	Returns the properties from a section instance in a CPF file by value in $list format More...
_.Library.Status	Modify (_.Library.String Name, _.Library.String Properties, _.Library.String CPFFile, _.Library.Integer Flags)
	Modify a section instance in a CPF file. More...
_.Library.ObjectHandle	Open (_.Library.String Name, _.Library.String CPFFile, _.Library.Integer concurrency, _.Library.Status Status, _.Library.Integer Flags)
	Open a section instance object in a CPF file. More...

Static Public Attributes
	CAPITALNAME = None
	Determines if the Name specified in the index should be capitalized. More...
	SECTIONTYPE = None
	This parameter governs how the class creates audit records. More...

Detailed Description

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

Member Function Documentation

Create()

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

static

Create a section instance in a CPF file.

Parameters:
Name - Name of the instance to create.
Properties (byref) - List of the properties to add in Properties(Name)=Value format. Available properties depend on the subclass.
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.
Bit $$$CPFSave - Save data to config database.
Bit $$$CPFWrite - Write config database to CPF file.
Bit $$$CPFActivate - 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.
If you have a batch of updates to do (like adding several devices, databases, or namespaces), then you should pass only Bit $$$CPFSave for each call. Then when creating the last one, don't pass any bits. This will cause all the previous additions to be written to the CPF file and activated all at once.

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

Delete()

_.Library.Status Delete ( _.Library.String  Name, _.Library.String  CPFFile, _.Library.Integer  Flags  )

static

Delete a section instance from a CPF file.

Parameters:
Name - Name of the instance to delete.
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. See the <METHOD>Create</METHOD> method for values.

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

Exists()

_.Library.Boolean Exists ( _.Library.String  Name, _.Library.ObjectHandle  Obj, _.Library.Status  Status, _.Library.String  CPFFile, _.Library.Integer  Flags  )

static

Database exists.

This method checks for the existence of a section instance in a CPF file.

Parameters:
Name - Name of the instance to check existence of.
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>Create</METHOD> method for values.

Return values:
If Value of the method = 0 (Instance does not exist, or some error occured)
Obj = Null
Status = Instance "x" does not exist, or other error message<br>
If Value of the method = 1 (Instance exists)
Obj = Object handle to Instance
CPFFile (byref) - Name of the CPF file the modification was made in.
Status = Instance "x" already exists

Get()

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

static

Get a section instances properties from a CPF file.

Parameters:
Name - Name of the instance to get.
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. Available properties depend on the subclass.
CPFFile (byref) - Name of the CPF file the modification was made in.

GetList()

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

static

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

Parameters:
Name - Name of the instance to get.
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 instance of the section

Modify()

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

static

Modify a section instance in a CPF file.

Parameters:
Name - Name of the instance to modify.
Properties (byref) - List of the properties to modify in Properties(Name)=Value format. Available properties depend on the subclass. 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. See the <METHOD>Create</METHOD> method for values.

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

Reimplemented in Databases, and Archives.

Open()

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

static

Open a section instance object in a CPF file.

Parameters:
Name - Name of the instance to open
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:
CPFFile (byref) - Name of the CPF file the modification was made in.

Member Data Documentation

CAPITALNAME

CAPITALNAME = None

static

Determines if the Name specified in the index should be capitalized.

SECTIONTYPE

SECTIONTYPE = None

static

This parameter governs how the class creates audit records.

Value = 0 - Class contains a single entry (SQL, Net, etc.)
Value = 1 - Class contains multiple entries (Databases, Namespaces, etc.)
Value = 2 - Class deals with mappings (MapGlobals, MapRoutines, MapPackages.)