All Frameworks Class Hierarchy This Framework Indexes
VPMInterfaces Interface CATIVpmServices
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIVpmServices
This class encapsulates various basic services.
Prefer to
use equivalent services proposed by the System FW when possible.
Method Index
- o
CheckFile(CATUnicodeString&)
-
- o
CreateSimpleContainer(CATUnicodeString&,CATUnicodeString&)
-
- o
GetDynamicObjList(CATUnicodeString&)
-
- o
GetEnv(CATUnicodeString&)
-
- o
GetIdentifier()
-
- o
GetOctetIdentifier()
-
- o
GetSettingSeparator()
-
- o
GetSetting(CATUnicodeString&,CATUnicodeString&)
-
- o
ListOfSettingVariables(CATUnicodeString&)
-
- o
LoadSchema(CATUnicodeString&)
-
- o
PutSettingSeparator(CATUnicodeString&)
-
- o
PutSetting(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
-
- o
RemoveSetting(CATUnicodeString&,CATUnicodeString&)
-
- o
SearchPath(CATUnicodeString&)
-
- o
SeekPath(CATUnicodeString&)
-
Methods
o CheckFile
| public virtual CheckFile( | const | iFullpath) |
-
- Deprecated:
- V5R15
Returns the access on a file.
- Parameters:
-
- iFullpath
- Name of the file
- Returns:
- A VPM_Access structure Exist/Read/Write/Execute
o CreateSimpleContainer
| public virtual CreateSimpleContainer( | const | iModelType, |
| const | iShemaName) |
-
- Deprecated:
- V5R15
Creates the simple container.
- Parameters:
-
- iModelType
- The type of the model
- iShemaName
- The name of the schema
o GetDynamicObjList
| public virtual GetDynamicObjList( | const | iInterfaceName) |
-
- Deprecated:
- V5R14
Returns the list of the dynamic objects.
- Parameters:
-
- iInterfaceName
- A specified interface's name
o GetEnv
| public virtual GetEnv( | const | iEnvName) |
-
- Deprecated:
- V5R15
Splits a path of a environment variable and puts all elements in a list.
- Parameters:
-
- iEnvName
- The name of the environment variable
o GetIdentifier
| public virtual GetIdentifier( | ) |
-
- Deprecated:
- V5R15
Returns a unique UUID as a CATUnicodeString.
o GetOctetIdentifier
| public virtual GetOctetIdentifier( | ) |
-
- Deprecated:
- V5R15
Returns a unique UUID as a sequence of octet.
o GetSettingSeparator
| public virtual GetSettingSeparator( | ) |
-
- Deprecated:
- V5R15
Gets the settings' separator.
o GetSetting
| public virtual GetSetting( | const | iSettingName, |
| const | iFileName) |
-
- Deprecated:
- V5R15
Returns the value of a setting.
- Parameters:
-
- iSettingName
- Name of the setting
- iFileName
- Name of the settings' file.
Attention the iFileName parameter cannot be a pathname, it must be the filename and that file must be in the CATUserSettingPath or CATReferenceSettingPath.
o ListOfSettingVariables
| public virtual ListOfSettingVariables( | const | iFileName) |
-
- Deprecated:
- V5R15
Gets the list of a setting variable.
- Parameters:
-
- iFileName
- Name of the settings' file
o LoadSchema
| public virtual LoadSchema( | const | iSchemaName) |
-
- Deprecated:
- V5R15
Loads a schema by its name.
- Parameters:
-
- iSchemaName
- Name of the schema
- Returns:
-
Legal values
- 0
- Load operation failed
- Other
- Load operation succeeded
o PutSettingSeparator
| public virtual PutSettingSeparator( | const | iSeparator) |
-
- Deprecated:
- V5R15
Puts a new settings' separator.
- Parameters:
-
- iSeparator
- The new separator
o PutSetting
| public virtual PutSetting( | const | iSettingName, |
| const | iSettingValue, |
| const | iFileName) |
-
- Deprecated:
- V5R15
Adds a new setting.
- Parameters:
-
- iSettingName
- Name of the new setting
- iSettingValue
- Value of the new setting
- iFileName
- Name of the settings' file
o RemoveSetting
| public virtual RemoveSetting( | const | iSettingName, |
| const | iFileName) |
-
- Deprecated:
- V5R15
Removes a setting.
- Parameters:
-
- iSettingName
- Name of the setting
- iFileName
- Name of the settings' file
o SearchPath
| public virtual SearchPath( | const | iFileName) |
-
- Deprecated:
- V5R14
Gets the path of a file using the SearchOrder by VPM_SEARCH_PATH in VPMAdmin Setting
- Parameters:
-
- iFileName
- Name of the file
o SeekPath
| public virtual SeekPath( | const | iFullPath) |
-
- Deprecated:
- V5R15
Splits a path of a file and puts all elements in a list.
- Parameters:
-
- iFullPath
- The whole path of the file
This object is included in the file: CATIVpmServices.h
If needed, your Imakefile.mk should include the module: GUIDVPMServices