Public View Protected View Private View

All Frameworks Class Hierarchy This Framework Indexes Previous Next

AutomationInterfaces Interface CATIScriptMacrosSettingAtt

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIScriptMacrosSettingAtt

Interface to handle the parameters of the macros settings.

This interface defines:

A method to set each parameter
A method to get the value of each parameter
A method to lock/unlock each parameter
A method to retrieve the informations concerning each parameter

Method Index

o GetDefaultMacroLibraries(CATListOfCATUnicodeString&): Retrieves the list of default macro libraries.
o GetDefaultMacroLibrariesInfo(CATSettingInfo*): Retrieves environment informations for the default macro libraries setting.
o GetExternalReferences(CATListOfCATUnicodeString&): Retrieves the list of external references.
o GetExternalReferencesInfo(CATSettingInfo*): Retrieves environment informations for the external references setting.
o GetLanguageEditor(CATScriptLanguage,CATUnicodeString&): Retrieves the editor path for the specified language.
o GetLanguageEditorInfo(CATSettingInfo*): Retrieves environment informations for the language editors setting.
o SetDefaultMacroLibraries(CATListOfCATUnicodeString&): Sets the list of default macro libraries.
o SetDefaultMacroLibrariesLock(unsigned char): Locks or unlocks the default macro libraries setting.
o SetExternalReferences(CATListOfCATUnicodeString&): Sets the list of external references.
o SetExternalReferencesLock(unsigned char): Locks or unlocks the external references setting.
o SetLanguageEditor(CATScriptLanguage,CATUnicodeString&): Sets the editor path for the specified language.
o SetLanguageEditorLock(unsigned char): Locks or unlocks the language editors setting.

Methods

o GetDefaultMacroLibraries

public virtual GetDefaultMacroLibraries( oLibraries)

Retrieves the list of default macro libraries.

Parameters:

oLibraries: The retrieved macro libraries.

o GetDefaultMacroLibrariesInfo

public virtual GetDefaultMacroLibrariesInfo( oInfo)

Retrieves environment informations for the default macro libraries setting.
Role:Retrieves the state of the parameter default macro libraries setting in the current environment.

Parameters:

AdminLevel: If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
oLocked: Indicates if the parameter has been locked.
oModified: Indicates if the parameter has been explicitly modified or remain to the administrated value.

o GetExternalReferences

public virtual GetExternalReferences( oReferences)

Retrieves the list of external references.

Parameters:

oReferences: The retrieved references.

o GetExternalReferencesInfo

public virtual GetExternalReferencesInfo( oInfo)

Retrieves environment informations for the external references setting.
Role:Retrieves the state of the parameter external references setting in the current environment.

Parameters:

AdminLevel: If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
oLocked: Indicates if the parameter has been locked.
oModified: Indicates if the parameter has been explicitly modified or remain to the administrated value.

o GetLanguageEditor

public virtual GetLanguageEditor(		`iLanguage`,
		`oEditorPath`)

Retrieves the editor path for the specified language.

Parameters:

iLanguage: The given scripting language.
oEditorPath: The retrieved editor path.

o GetLanguageEditorInfo

public virtual GetLanguageEditorInfo( oInfo)

Retrieves environment informations for the language editors setting.
Role:Retrieves the state of the parameter language editors setting in the current environment.

Parameters:

AdminLevel: If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
oLocked: Indicates if the parameter has been locked.
oModified: Indicates if the parameter has been explicitly modified or remain to the administrated value.

o SetDefaultMacroLibraries

public virtual SetDefaultMacroLibraries( const iLibraries)

Sets the list of default macro libraries.

Parameters:

iLibraries: The macro libraries to set.

o SetDefaultMacroLibrariesLock

public virtual SetDefaultMacroLibrariesLock( iLock)

Locks or unlocks the default macro libraries setting.
Role:Locks or unlocks the default macro libraries setting if it is possible in the current administrative context. In user mode this method will always return E_FAIL.

Parameters:

iLocked: the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.

o SetExternalReferences

public virtual SetExternalReferences( const iReferences)

Sets the list of external references.

Parameters:

iReferences: The references to set.

o SetExternalReferencesLock

public virtual SetExternalReferencesLock( iLock)

Locks or unlocks the external references setting.
Role:Locks or unlocks the external references setting if it is possible in the current administrative context. In user mode this method will always return E_FAIL.

Parameters:

iLocked: the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.

o SetLanguageEditor

public virtual SetLanguageEditor(		`iLanguage`,
	const	`iEditorPath`)

Sets the editor path for the specified language.

Parameters:

iLanguage: The given scripting language.
iEditorPath: The editor path to set.

o SetLanguageEditorLock

public virtual SetLanguageEditorLock( iLock)

Locks or unlocks the language editors setting.
Role:Locks or unlocks the language editors setting if it is possible in the current administrative context. In user mode this method will always return E_FAIL.

Parameters:

iLocked: the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.

This object is included in the file: CATIScriptMacrosSettingAtt.h