System Interface CATISysDLNameSettingAtt
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATISysDLNameSettingAtt
Interface to handle the DLNames.
Role: This interface is implemented by a component which
represents the controller of the DLNames.
This interface defines:
- A method to set each DLNamw
- A method to get the value of each DLName
- A method to lock/unlock each parameter
- A method to retrieve the informations concerning each parameter
Method Index
- o
GetDLName(CATUnicodeString*,CATUnicodeString**,CATUnicodeString**,CATUnicodeString**)
- Retrieves the mapping between a logical name and the physical path.
- o
GetDLNameCreationRight(unsigned char&)
- Retrieves if one has the right to create or delete new DLNames .
- o
GetDLNameCreationRightInfo(CATSettingInfo*)
- Retrieves the state of the parameter DLNameCreationRight.
- o
GetDLNameExp(CATUnicodeString*,CATUnicodeString**,CATUnicodeString**,CATUnicodeString**)
- Retrieves the mapping between a logical name and the physical path.
- o
GetDLNameInfo(CATUnicodeString*,CATSettingInfo*)
- Retrieves the state of the for a given DLName.
- o
GetDLNameList(unsigned int*,CATUnicodeString**&)
- Retrieves the list of the DLNames.
- o
GetDLNameSubList(CATUnicodeString*,unsigned int*,CATUnicodeString**&)
- Retrieves the list of the Sub-DLNames.
- o
GetRootDLNameCreationRight(unsigned char&)
- Retrieves if one has the right to create new Root DLNames.
- o
GetRootDLNameCreationRightInfo(CATSettingInfo*)
- Retrieves the state of the parameter RootDLNameCreationRight.
- o
RemoveDLName(CATUnicodeString*)
- Remove a logical name.
- o
RenameDLName(CATUnicodeString*,CATUnicodeString*)
- Rename an existing DLName.
- o
SetDLName(CATUnicodeString*,CATUnicodeString*,CATUnicodeString*,CATUnicodeString*,int)
- Sets the mapping between a logical name and the physical path.
- o
SetDLNameCreationRight(unsigned char)
- Sets the creation right.
- o
SetDLNameCreationRightLock(unsigned char)
- Locks or unlocks the parameter DLNameCreationRight.
- o
SetDLNameLock(CATUnicodeString*,unsigned char)
- Locks or unlocks the DLName.
- o
SetRootDLNameCreationRight(unsigned char)
- Sets the creation right of Root DLNames.
- o
SetRootDLNameCreationRightLock(unsigned char)
- Locks or unlocks the parameter RootDLNameCreationRight.
Methods
o GetDLName
| public virtual GetDLName( | const | iDLName, |
| | oRealNameUnix, |
| | oRealNameNT, |
| | oFather) |
-
Retrieves the mapping between a logical name and the physical path.
Role: Retrieves the mapping between a logical name and
the physical path.
- Parameters:
-
- iDLName
- the logical name.
- oRealNameUnix
- the real physical path corresponding to the logical name on Unix.
- oRealNameNT
- the real physical path corresponding to the logical name on Windows.
- iFather
- if applicable the Name of the parent DLName
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDLNameCreationRight
| public virtual GetDLNameCreationRight( | | oRight) |
-
Retrieves if one has the right to create or delete new DLNames .
Role: Retrieves the value of the parameter describing if one has
the right to create or deletenew DLNames in the current list.
- Parameters:
-
- oRight
- TRUE if the creation is authorized.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDLNameCreationRightInfo
| public virtual GetDLNameCreationRightInfo( | | oInfo) |
-
Retrieves the state of the parameter DLNameCreationRight.
Refer to
for a detailled description.
o GetDLNameExp
| public virtual GetDLNameExp( | const | iDLName, |
| | oRealNameUnix, |
| | oRealNameNT, |
| | oFather) |
-
Retrieves the mapping between a logical name and the physical path.
Role: Retrieves the mapping between a logical name and
the physical path in a litteral form.
- Parameters:
-
- iDLName
- the logical name.
- oRealNameUnix
- the real physical path corresponding to the logical name on Unix.
- oRealNameNT
- the real physical path corresponding to the logical name on Windows.
- iFather
- if applicable the Name of the parent DLName
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDLNameInfo
| public virtual GetDLNameInfo( | const | iDLName, |
| | oInfo) |
-
Retrieves the state of the for a given DLName.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDLNameList
| public virtual GetDLNameList( | | oNbDLname, |
| | oTabDLName) |
-
Retrieves the list of the DLNames.
Role: Retrieves the list of the defined DLNames.
- Parameters:
-
- oNbDLname
- The number of defined DLNames.
- oTabDLName
- The array of DLNames
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDLNameSubList
| public virtual GetDLNameSubList( | | iDLName, |
| | oNbDLname, |
| | oTabDLName) |
-
Retrieves the list of the Sub-DLNames.
Role: Retrieves the list of the DLNames created in a given DLName.
- Parameters:
-
- iDLName
- The Father DLName. if iDLName=NULL all DLNames created at the root level
are return.
- oNbDLname
- The number of defined DLNames.
- oTabDLName
- The array of DLNames
- Returns:
- Legal values:
S_OK : on Success
E_OUTOFMEMORY: on allocation failure
E_FAIL: on other failures
o GetRootDLNameCreationRight
| public virtual GetRootDLNameCreationRight( | | oRight) |
-
Retrieves if one has the right to create new Root DLNames.
Role: Retrieves the value of the parameter describing if one has
the right to create new DLNames in the current list.
- Parameters:
-
- oRight
- TRUE if the creation is authorized.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetRootDLNameCreationRightInfo
| public virtual GetRootDLNameCreationRightInfo( | | oInfo) |
-
Retrieves the state of the parameter RootDLNameCreationRight.
Refer to
for a detailled description.
o RemoveDLName
| public virtual RemoveDLName( | const | iDLName) |
-
Remove a logical name.
Role: Remove a DLName in the current set if it is possible.
- Parameters:
-
- iDLName
- the logical name.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o RenameDLName
| public virtual RenameDLName( | const | iDLName, |
| const | iNewName) |
-
Rename an existing DLName.
Role: Rename a DLName in the current set if it is possible.
- Parameters:
-
- iDLName
- the logical name to rename.
- iNewName
- the new logical name.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDLName
| public virtual SetDLName( | const | iDLName, |
| const | iRealNameUnix, |
| const | iRealNameNT, |
| const | iFather, |
| | iVerifDirectory | =0) |
-
Sets the mapping between a logical name and the physical path.
Role: Sets the value of the cache maximum size in Mo
- Parameters:
-
- iDLName
- the logical name.
- oRealNameUnix
- the real physical path corresponding to the logical name on Unix.
- oRealNameNT
- the real physical path corresponding to the logical name on Windows.
- iFather
- if applicable the Name of the parent DLName
- iVerifDirectory
- if VerifDirectory is set the existence of the directory on the current
platform will be check.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDLNameCreationRight
| public virtual SetDLNameCreationRight( | | iRight) |
-
Sets the creation right.
Role: Sets the right to create new DLNames in the current list.
- Parameters:
-
- iRight
- TRUE if the creation is authorized, FALSE to forbid it
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDLNameCreationRightLock
| public virtual SetDLNameCreationRightLock( | | iLock) |
-
Locks or unlocks the parameter DLNameCreationRight.
Role: Retrieves the state of the parameter describing if one has
o SetDLNameLock
| public virtual SetDLNameLock( | const | iDLName, |
| | iLock) |
-
Locks or unlocks the DLName.
Role: Locks or unlocks the given DLName if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetRootDLNameCreationRight
| public virtual SetRootDLNameCreationRight( | | iRight) |
-
Sets the creation right of Root DLNames.
Role: Sets the right to create new Root DLNames in the current
list.
- Parameters:
-
- iRight
- TRUE if the creation is authorized, FALSE to forbid it
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetRootDLNameCreationRightLock
| public virtual SetRootDLNameCreationRightLock( | | iLock) |
-
Locks or unlocks the parameter RootDLNameCreationRight.
Refer to
for a detailled description.
This object is included in the file: CATISysDLNameSettingAtt.h
If needed, your Imakefile.mk should include the module: JS0GROUP
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.