MapShadows Class Reference

This class allows you to modify and view global mappings in the [Map.xxx] section of the CPF file through programatic APIs. More...

Inheritance diagram for MapShadows:

Collaboration diagram for MapShadows:

Public Attributes
	Directory
	Database to map global to. More...
Public Attributes inherited from GenericMapProperties
	CPFFile
	CPF file which the object maps to. More...
	Comments
	Embedded comments in the CPF file. More...
	Flags
	Flags governing how the object is processed when Save() is called. More...
	ID
	ID where the mapping is. More...
	Name
	Name of the mapping. More...

Static Public Attributes
	CAPITALNAME = None
	Determines if the Name specified in the index should be capitalized. More...
Static Public Attributes inherited from GenericMapMethods
	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...
Static Public Attributes inherited from GenericMapProperties
	DOMAIN = None
	This class contains properties which are included by classes which manipulate namespace mappings in the CPF file. More...

Static Private Member Functions
_.Library.Status	OnDeleteCallBack (_.Library.ObjectHandle Obj)
	Called from Delete(). More...

Additional Inherited Members
Static Public Member Functions inherited from GenericMapMethods
_.Library.Status	Delete (_.Library.String ID, _.Library.String Name, _.Library.String CPFFile, _.Library.Integer Flags)
	Delete a mapping from a CPF file. More...
_.Library.Boolean	Exists (ID, _.Library.String Name, _.Library.ObjectHandle Obj, _.Library.Status Status, _.Library.String CPFFile, _.Library.Integer Flags)
	Checks for the existence of a mapping in a CPF file. More...
_.Library.Status	Get (_.Library.String ID, _.Library.String Name, _.Library.String Properties, _.Library.String CPFFile, _.Library.Integer Flags)
	Get a mapping's properties from a CPF file. More...
_.Library.Status	GetList (_.Library.String ID, _.Library.String Name, _.Library.String CPFFile, _.Library.Integer Flags)
	Returns the properties from a instance of a mapping section from a CPF file by value in $list format More...
_.Library.Status	Modify (_.Library.String ID, _.Library.String Name, _.Library.String Properties, _.Library.String CPFFile, _.Library.Integer Flags)
	Modify a mapping in a CPF file. More...
_.Library.ObjectHandle	Open (_.Library.String ID, _.Library.String Name, _.Library.String CPFFile, _.Library.Integer concurrency, _.Library.Status Status, _.Library.Integer Flags)
	Open an instance of a mapping object in a CPF file. More...

Detailed Description

This class allows you to modify and view global mappings in the [Map.xxx] section of the CPF file through programatic APIs.

While properties are usually modified through the System Management portal, there may be some occasion where modifying them through the API's is best for your system. In all the Config methods, if you do not specify the CPFFile parameter, the currently active CPF file is used. If you wish to modify a CPF file which is not the currently active one, then specify the CPFFile you wish to modify in the method call.
The Flags parameter does not normally need to be specified; the defaults are usually sufficient for most cases.
You can use either the provided API's (Create/Get/Modify/Delete) to modify the properties by passing in the correct parameters, or use Object syntax to open and directly manipulate the config objects (Open() and Exists()). Most objects created here need only to specify the Name of the object, and 1 or 2 properties since the the defaults are what are commonly used for most cases.

EXAMPLE:

Member Function Documentation

OnDeleteCallBack()

_.Library.Status OnDeleteCallBack ( _.Library.ObjectHandle  Obj )

staticprivate

Called from Delete().

Any error returned here will keep the object from being deleted.

Member Data Documentation

CAPITALNAME

CAPITALNAME = None

static

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

Directory

Directory

Database to map global to.