Show / Hide Table of Contents

Class ExtensionManagerHelper

Static class to get instance of extension manager

Inheritance

object

ExtensionManagerHelper

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: CAMAPI.DotnetHelper

Assembly: CAMAPI.DotnetHelper.dll

Syntax

public static class ExtensionManagerHelper

Methods

AddExtension(ComWrapper<IExtensionManager>, TStorageType, string, string)

Add extension to storage, so we could modify its enabled state for this storage

Declaration

public static void AddExtension(this ComWrapper<IExtensionManager> managerCom, TStorageType storageType, string libraryPath, string extensionTypeId)

Parameters

Type	Name	Description
ComWrapper<IExtensionManager>	managerCom
TStorageType	storageType
string	libraryPath
string	extensionTypeId

ApiDependencies()

Get a list of all dependent DLLs, which contain API methods

Declaration

public static ComWrapper<IListString> ApiDependencies()

Returns

Type	Description
ComWrapper<IListString>

ApiDependencies(ComWrapper<IExtensionManager>)

Get a list of all dependent DLLs, which contain API methods

Declaration

public static ComWrapper<IListString> ApiDependencies(this ComWrapper<IExtensionManager> managerCom)

Parameters

Type	Name	Description
ComWrapper<IExtensionManager>	managerCom

Returns

Type	Description
ComWrapper<IListString>

ApiVersion()

Get version CAMAPI.SDK, which includes all interfaces

Declaration

public static string ApiVersion()

Returns

Type	Description
string

ApiVersion(ComWrapper<IExtensionManager>)

Get version CAMAPI.SDK, which includes all interfaces

Declaration

public static string ApiVersion(this ComWrapper<IExtensionManager> managerCom)

Parameters

Type	Name	Description
ComWrapper<IExtensionManager>	managerCom

Returns

Type	Description
string

CreateExtension(ComWrapper<IExtensionManager>, string)

Create new instance of IExtension by unique ident

Declaration

public static ComWrapper<IExtension> CreateExtension(this ComWrapper<IExtensionManager> managerCom, string extensionTypeId)

Parameters

Type	Name	Description
ComWrapper<IExtensionManager>	managerCom
string	extensionTypeId

Returns

Type	Description
ComWrapper<IExtension>

CreateExtensionsByGroups(ComWrapper<IExtensionManager>, string)

Create new instances of extensions searching by extension groups (semicolon separated)

Declaration

public static ComWrapper<IListExtension> CreateExtensionsByGroups(this ComWrapper<IExtensionManager> managerCom, string extensionGroups)

Parameters

Type	Name	Description
ComWrapper<IExtensionManager>	managerCom
string	extensionGroups

Returns

Type	Description
ComWrapper<IListExtension>

FinalizeExtensions(ComWrapper<IExtensionManager>)

Unload all extensions during the program finalization

Declaration

public static void FinalizeExtensions(this ComWrapper<IExtensionManager> managerCom)

Parameters

Type	Name	Description
ComWrapper<IExtensionManager>	managerCom

FreeExtension(ComWrapper<IExtensionManager>, long)

Unload extension by instance ID

Declaration

public static void FreeExtension(this ComWrapper<IExtensionManager> managerCom, long extensionInstanceId)

Parameters

Type	Name	Description
ComWrapper<IExtensionManager>	managerCom
long	extensionInstanceId

FreeExtensionsByTypeId(ComWrapper<IExtensionManager>, string)

Unload extension by type ID

Declaration

public static void FreeExtensionsByTypeId(this ComWrapper<IExtensionManager> managerCom, string extensionTypeId)

Parameters

Type	Name	Description
ComWrapper<IExtensionManager>	managerCom
string	extensionTypeId

FreeLibrary(ComWrapper<IExtensionManager>, string)

Unload all extensions from specified library and unload library

Declaration

public static void FreeLibrary(this ComWrapper<IExtensionManager> managerCom, string libraryPath)

Parameters

Type	Name	Description
ComWrapper<IExtensionManager>	managerCom
string	libraryPath

GetExtension(ComWrapper<IExtensionManager>, long)

Return an existing instance of IExtension by instance ID

Declaration

public static ComWrapper<IExtension> GetExtension(this ComWrapper<IExtensionManager> managerCom, long extensionInstanceId)

Parameters

Type	Name	Description
ComWrapper<IExtensionManager>	managerCom
long	extensionInstanceId

Returns

Type	Description
ComWrapper<IExtension>

GetExtension(long)

Return an existing instance of IExtension by instance ID

Declaration

public static ComWrapper<IExtension> GetExtension(long extensionInstanceId)

Parameters

Type	Name	Description
long	extensionInstanceId

Returns

Type	Description
ComWrapper<IExtension>

GetExtensionDisabled(ComWrapper<IExtensionManager>, TStorageType, string)

Get information if extension is disabled for storage

Declaration

public static bool GetExtensionDisabled(this ComWrapper<IExtensionManager> managerCom, TStorageType storageType, string extensionTypeId)

Parameters

Type	Name	Description
ComWrapper<IExtensionManager>	managerCom
TStorageType	storageType
string	extensionTypeId

Returns

Type	Description
bool

GetExtensionDisabledFinal(ComWrapper<IExtensionManager>, string)

Get information if extension is disabled after reading all storage

Declaration

public static bool GetExtensionDisabledFinal(this ComWrapper<IExtensionManager> managerCom, string extensionTypeId)

Parameters

Type	Name	Description
ComWrapper<IExtensionManager>	managerCom
string	extensionTypeId

Returns

Type	Description
bool

GetExtensionTypeGroup(ComWrapper<IExtensionManager>, string)

Get extension type group info by its unique ident

Declaration

public static ComWrapper<IExtensionTypeGroup> GetExtensionTypeGroup(this ComWrapper<IExtensionManager> managerCom, string groupId)

Parameters

Type	Name	Description
ComWrapper<IExtensionManager>	managerCom
string	groupId

Returns

Type	Description
ComWrapper<IExtensionTypeGroup>

GetExtensionTypeGroups(ComWrapper<IExtensionManager>)

Get all available groups of extension types

Declaration

public static ComWrapper<IListString> GetExtensionTypeGroups(this ComWrapper<IExtensionManager> managerCom)

Parameters

Type	Name	Description
ComWrapper<IExtensionManager>	managerCom

Returns

Type	Description
ComWrapper<IListString>

GetExtensionTypeInfo(ComWrapper<IExtensionManager>, string)

Get only extension properties, searching by its unique ident

Declaration

public static ComWrapper<IExtensionTypeInfo> GetExtensionTypeInfo(this ComWrapper<IExtensionManager> managerCom, string extensionTypeId)

Parameters

Type	Name	Description
ComWrapper<IExtensionManager>	managerCom
string	extensionTypeId

Returns

Type	Description
ComWrapper<IExtensionTypeInfo>

GetExtensionTypeInfos(ComWrapper<IExtensionManager>, string)

Get extension types by group of extension type

Declaration

public static ComWrapper<IListExtensionTypeInfo> GetExtensionTypeInfos(this ComWrapper<IExtensionManager> managerCom, string extensionTypeGroup)

Parameters

Type	Name	Description
ComWrapper<IExtensionManager>	managerCom
string	extensionTypeGroup

Returns

Type	Description
ComWrapper<IListExtensionTypeInfo>

GetExtensionTypeInfosFromLibrary(ComWrapper<IExtensionManager>, string)

Get all extension properties included in library (search by DLL path)

Declaration

public static ComWrapper<IListExtensionTypeInfo> GetExtensionTypeInfosFromLibrary(this ComWrapper<IExtensionManager> managerCom, string libraryPath)

Parameters

Type	Name	Description
ComWrapper<IExtensionManager>	managerCom
string	libraryPath

Returns

Type	Description
ComWrapper<IListExtensionTypeInfo>

GetExtensionsByTypeId(ComWrapper<IExtensionManager>, string)

Return list of created extensions for specified type

Declaration

public static ComWrapper<IListExtension> GetExtensionsByTypeId(this ComWrapper<IExtensionManager> managerCom, string extensionTypeId)

Parameters

Type	Name	Description
ComWrapper<IExtensionManager>	managerCom
string	extensionTypeId

Returns

Type	Description
ComWrapper<IListExtension>

GetFieldInherited(ComWrapper<IExtensionManager>, TStorageType, string, TStorageField)

Get if current value is inherited from specified storage

Declaration

public static bool GetFieldInherited(this ComWrapper<IExtensionManager> managerCom, TStorageType storageType, string entityIdent, TStorageField field)

Parameters

Type	Name	Description
ComWrapper<IExtensionManager>	managerCom
TStorageType	storageType
string	entityIdent
TStorageField	field

Returns

Type	Description
bool

GetInstance()

Get instance of extension manager from main CAM application

Declaration

public static ComWrapper<IExtensionManager> GetInstance()

Returns

Type	Description
ComWrapper<IExtensionManager>

GetLibrariesInfo(ComWrapper<IExtensionManager>)

Get information about all registered libraries

Declaration

public static ComWrapper<IListExtensionLibraryInfo> GetLibrariesInfo(this ComWrapper<IExtensionManager> managerCom)

Parameters

Type	Name	Description
ComWrapper<IExtensionManager>	managerCom

Returns

Type	Description
ComWrapper<IListExtensionLibraryInfo>

GetLibraryDisabled(ComWrapper<IExtensionManager>, TStorageType, string)

Get information if library is disabled for storage

Declaration

public static bool GetLibraryDisabled(this ComWrapper<IExtensionManager> managerCom, TStorageType storageType, string libraryPath)

Parameters

Type	Name	Description
ComWrapper<IExtensionManager>	managerCom
TStorageType	storageType
string	libraryPath

Returns

Type	Description
bool

GetLibraryDisabledFinal(ComWrapper<IExtensionManager>, string)

Get information if library is disabled after reading all storage

Declaration

public static bool GetLibraryDisabledFinal(this ComWrapper<IExtensionManager> managerCom, string libraryPath)

Parameters

Type	Name	Description
ComWrapper<IExtensionManager>	managerCom
string	libraryPath

Returns

Type	Description
bool

GetLibraryInfo(ComWrapper<IExtensionManager>, string)

Get extension library properties by unique ident of extension inside it

Declaration

public static ComWrapper<IExtensionLibraryInfo> GetLibraryInfo(this ComWrapper<IExtensionManager> managerCom, string extensionTypeId)

Parameters

Type	Name	Description
ComWrapper<IExtensionManager>	managerCom
string	extensionTypeId

Returns

Type	Description
ComWrapper<IExtensionLibraryInfo>

GetLibraryLoaded(ComWrapper<IExtensionManager>, string)

Get information if library is loaded

Declaration

public static bool GetLibraryLoaded(this ComWrapper<IExtensionManager> managerCom, string libraryPath)

Parameters

Type	Name	Description
ComWrapper<IExtensionManager>	managerCom
string	libraryPath

Returns

Type	Description
bool

GetLibraryStorages(ComWrapper<IExtensionManager>, string)

Get all storages, where library has non-inherited values

Declaration

public static ComWrapper<IListInteger> GetLibraryStorages(this ComWrapper<IExtensionManager> managerCom, string libraryPath)

Parameters

Type	Name	Description
ComWrapper<IExtensionManager>	managerCom
string	libraryPath

Returns

Type	Description
ComWrapper<IListInteger>

GetPendingDeletionLibraries(ComWrapper<IExtensionManager>)

Get libraries with pending deletion (DLL was locked during UnRegisterLibrary). Returns libraries whose del cleanup artifact still exists on disk. Stale entries (artifact already gone) are removed automatically.

Declaration

public static ComWrapper<IListExtensionLibraryInfo> GetPendingDeletionLibraries(this ComWrapper<IExtensionManager> managerCom)

Parameters

Type	Name	Description
ComWrapper<IExtensionManager>	managerCom

Returns

Type	Description
ComWrapper<IListExtensionLibraryInfo>

GetSingletonExtension(ComWrapper<IExtensionManager>, string)

Return an extension instance when it is singleton

Declaration

public static ComWrapper<IExtension> GetSingletonExtension(this ComWrapper<IExtensionManager> managerCom, string extensionTypeId)

Parameters

Type	Name	Description
ComWrapper<IExtensionManager>	managerCom
string	extensionTypeId

Returns

Type	Description
ComWrapper<IExtension>

GetSingletonExtension(string)

Return an extension instance when it is singleton

Declaration

public static ComWrapper<IExtension> GetSingletonExtension(string extensionTypeId)

Parameters

Type	Name	Description
string	extensionTypeId

Returns

Type	Description
ComWrapper<IExtension>

Logger()

Logging object

Declaration

public static ComWrapper<IExtensionLogger> Logger()

Returns

Type	Description
ComWrapper<IExtensionLogger>

Logger(ComWrapper<IExtensionManager>)

Logging object

Declaration

public static ComWrapper<IExtensionLogger> Logger(this ComWrapper<IExtensionManager> managerCom)

Parameters

Type	Name	Description
ComWrapper<IExtensionManager>	managerCom

Returns

Type	Description
ComWrapper<IExtensionLogger>

RegisterLibrary(ComWrapper<IExtensionManager>, TStorageType, string)

Add a description file to storage

Declaration

public static ComWrapper<IExtensionLibraryInfo> RegisterLibrary(this ComWrapper<IExtensionManager> managerCom, TStorageType storageType, string jsonFilePath)

Parameters

Type	Name	Description
ComWrapper<IExtensionManager>	managerCom
TStorageType	storageType
string	jsonFilePath

Returns

Type	Description
ComWrapper<IExtensionLibraryInfo>

RegisterLibraryFromFolder(ComWrapper<IExtensionManager>, TStorageType, string, out bool)

Add a description file to storage

Declaration

public static ComWrapper<IExtensionLibraryInfo> RegisterLibraryFromFolder(this ComWrapper<IExtensionManager> managerCom, TStorageType storageType, string folderPath, out bool needReload)

Parameters

Type	Name	Description
ComWrapper<IExtensionManager>	managerCom
TStorageType	storageType
string	folderPath
bool	needReload

Returns

Type	Description
ComWrapper<IExtensionLibraryInfo>

ReloadStorage(ComWrapper<IExtensionManager>, TStorageType)

Re-read storage

Declaration

public static void ReloadStorage(this ComWrapper<IExtensionManager> managerCom, TStorageType storageType)

Parameters

Type	Name	Description
ComWrapper<IExtensionManager>	managerCom
TStorageType	storageType

RemoveExtension(ComWrapper<IExtensionManager>, TStorageType, string, string)

Remove extension from storage, so we could not modify its enabled state for this storage

Declaration

public static void RemoveExtension(this ComWrapper<IExtensionManager> managerCom, TStorageType storageType, string libraryPath, string extensionTypeId)

Parameters

Type	Name	Description
ComWrapper<IExtensionManager>	managerCom
TStorageType	storageType
string	libraryPath
string	extensionTypeId

SetExtensionDisabled(ComWrapper<IExtensionManager>, TStorageType, string, bool)

Set extension is disabled for storage

Declaration

public static void SetExtensionDisabled(this ComWrapper<IExtensionManager> managerCom, TStorageType storageType, string extensionTypeId, bool disabled)

Parameters

Type	Name	Description
ComWrapper<IExtensionManager>	managerCom
TStorageType	storageType
string	extensionTypeId
bool	disabled

SetFieldInherited(ComWrapper<IExtensionManager>, TStorageType, string, TStorageField)

Set if current value in specified storage should be inherited from lower storage

Declaration

public static void SetFieldInherited(this ComWrapper<IExtensionManager> managerCom, TStorageType storageType, string entityIdent, TStorageField field)

Parameters

Type	Name	Description
ComWrapper<IExtensionManager>	managerCom
TStorageType	storageType
string	entityIdent
TStorageField	field

SetLibraryDisabled(ComWrapper<IExtensionManager>, TStorageType, string, bool)

Set library is disabled for storage

Declaration

public static void SetLibraryDisabled(this ComWrapper<IExtensionManager> managerCom, TStorageType storageType, string libraryPath, bool disabled)

Parameters

Type	Name	Description
ComWrapper<IExtensionManager>	managerCom
TStorageType	storageType
string	libraryPath
bool	disabled

UnRegisterLibrary(ComWrapper<IExtensionManager>, string)

Remove description file from storage

Declaration

public static void UnRegisterLibrary(this ComWrapper<IExtensionManager> managerCom, string libraryPath)

Parameters

Type	Name	Description
ComWrapper<IExtensionManager>	managerCom
string	libraryPath