All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMInterfaces Interface CATIVpmServices

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---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 GetSetting(CATUnicodeString&,CATUnicodeString&)
o GetSettingSeparator()
o ListOfSettingVariables(CATUnicodeString&)
o LoadSchema(CATUnicodeString&)
o PutSetting(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
o PutSettingSeparator(CATUnicodeString&)
o RemoveSetting(CATUnicodeString&,CATUnicodeString&)
o SearchPath(CATUnicodeString&)
o SeekPath(CATUnicodeString&)

Methods


o CheckFile
public virtual VPM_Access CheckFile( const CATUnicodeString& iFullpath) =0
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 CATIContainer_var CreateSimpleContainer( const CATUnicodeString& iModelType,
const CATUnicodeString& iShemaName)=0
Deprecated:
V5R15 Creates the simple container.
Parameters:
iModelType
The type of the model
iShemaName
The name of the schema
o GetDynamicObjList
public virtual CATListOfCATUnicodeString GetDynamicObjList( const CATUnicodeString& iInterfaceName) =0
Deprecated:
V5R14 Returns the list of the dynamic objects.
Parameters:
iInterfaceName
A specified interface's name
o GetEnv
public virtual CATListOfCATUnicodeString GetEnv( const CATUnicodeString& iEnvName) =0
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 CATUnicodeString GetIdentifier()=0
Deprecated:
V5R15 Returns a unique UUID as a CATUnicodeString.
o GetOctetIdentifier
public virtual SEQUENCE(octet) GetOctetIdentifier()=0
Deprecated:
V5R15 Returns a unique UUID as a sequence of octet.
o GetSetting
public virtual CATUnicodeString GetSetting( const CATUnicodeString& iSettingName,
const CATUnicodeString& iFileName)=0
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 GetSettingSeparator
public virtual CATUnicodeString GetSettingSeparator()=0
Deprecated:
V5R15 Gets the settings' separator.
o ListOfSettingVariables
public virtual CATListOfCATUnicodeString ListOfSettingVariables( const CATUnicodeString& iFileName)=0
Deprecated:
V5R15 Gets the list of a setting variable.
Parameters:
iFileName
Name of the settings' file
o LoadSchema
public virtual int LoadSchema( const CATUnicodeString& iSchemaName) =0
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 PutSetting
public virtual HRESULT PutSetting( const CATUnicodeString& iSettingName,
const CATUnicodeString& iSettingValue,
const CATUnicodeString& iFileName)=0
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 PutSettingSeparator
public virtual void PutSettingSeparator( const CATUnicodeString& iSeparator) =0
Deprecated:
V5R15 Puts a new settings' separator.
Parameters:
iSeparator
The new separator
o RemoveSetting
public virtual HRESULT RemoveSetting( const CATUnicodeString& iSettingName,
const CATUnicodeString& iFileName)=0
Deprecated:
V5R15 Removes a setting.
Parameters:
iSettingName
Name of the setting
iFileName
Name of the settings' file
o SearchPath
public virtual CATUnicodeString SearchPath( const CATUnicodeString& iFileName)=0
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 CATListOfCATUnicodeString SeekPath( const CATUnicodeString& iFullPath) =0
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

Copyright © 2003, Dassault Systèmes. All rights reserved.