Interface IIpcExtensionManager

Wrapper over interface IExtensionManager in CAM Open API to execute its methods through IPC

Namespace: CAMIPC.ExtensionManager

Assembly: CAMIPC.ExtensionManager.dll

Syntax

[Guid("E3D507C1-0299-4211-AA6D-20CB3489F0EA")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
public interface IIpcExtensionManager

Methods

AddExtension(TStorageType, string, string, ref TExecuteContext)

Declaration

void AddExtension(TStorageType StorageType, string LibraryPath, string ExtensionTypeId, ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
TStorageType	StorageType
string	LibraryPath
string	ExtensionTypeId
TExecuteContext	ExecuteContext

CreateExtension(string, ref TExecuteContext)

Declaration

IIpcExtension CreateExtension(string ExtensionTypeId, ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
string	ExtensionTypeId
TExecuteContext	ExecuteContext

Returns

Type	Description
IIpcExtension

CreateExtensions(string, ref TExecuteContext)

Declaration

IIpcListExtension CreateExtensions(string ExtensionTypeIds, ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
string	ExtensionTypeIds
TExecuteContext	ExecuteContext

Returns

Type	Description
IIpcListExtension

FreeExtension(long, ref TExecuteContext)

Declaration

void FreeExtension(long ExtensionInstanceId, ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
long	ExtensionInstanceId
TExecuteContext	ExecuteContext

FreeLibrary(string, ref TExecuteContext)

Declaration

void FreeLibrary(string LibraryPath, ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
string	LibraryPath
TExecuteContext	ExecuteContext

GetApiDependencies(ref TExecuteContext)

Declaration

IListString GetApiDependencies(ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
TExecuteContext	ExecuteContext

Returns

Type	Description
IListString

GetApiVersion(ref TExecuteContext)

Declaration

string GetApiVersion(ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
TExecuteContext	ExecuteContext

Returns

Type	Description
string

GetExtension(long, ref TExecuteContext)

Declaration

IIpcExtension GetExtension(long ExtensionInstanceId, ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
long	ExtensionInstanceId
TExecuteContext	ExecuteContext

Returns

Type	Description
IIpcExtension

GetExtensionDisabled(TStorageType, string, ref TExecuteContext)

Declaration

bool GetExtensionDisabled(TStorageType StorageType, string ExtensionIdent, ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
TStorageType	StorageType
string	ExtensionIdent
TExecuteContext	ExecuteContext

Returns

Type	Description
bool

GetExtensionSetting(string, string, out bool, ref TExecuteContext)

Declaration

string GetExtensionSetting(string ExtensionTypeId, string Key, out bool found, ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
string	ExtensionTypeId
string	Key
bool	found
TExecuteContext	ExecuteContext

Returns

Type	Description
string

GetExtensionSettingKeys(string, ref TExecuteContext)

Declaration

IListString GetExtensionSettingKeys(string ExtensionTypeId, ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
string	ExtensionTypeId
TExecuteContext	ExecuteContext

Returns

Type	Description
IListString

GetExtensionSettingSourceLevel(string, string, out bool, out bool, ref TExecuteContext)

Declaration

TStorageType GetExtensionSettingSourceLevel(string ExtensionTypeId, string Key, out bool found, out bool fromDefault, ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
string	ExtensionTypeId
string	Key
bool	found
bool	fromDefault
TExecuteContext	ExecuteContext

Returns

Type	Description
TStorageType

GetExtensionTypeGroup(string, ref TExecuteContext)

Declaration

IIpcExtensionTypeGroup GetExtensionTypeGroup(string ExtensionTypeGroupId, ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
string	ExtensionTypeGroupId
TExecuteContext	ExecuteContext

Returns

Type	Description
IIpcExtensionTypeGroup

GetExtensionTypeGroups(ref TExecuteContext)

Declaration

IListString GetExtensionTypeGroups(ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
TExecuteContext	ExecuteContext

Returns

Type	Description
IListString

GetExtensionTypeInfo(string, ref TExecuteContext)

Declaration

IIpcExtensionTypeInfo GetExtensionTypeInfo(string ExtensionTypeId, ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
string	ExtensionTypeId
TExecuteContext	ExecuteContext

Returns

Type	Description
IIpcExtensionTypeInfo

GetExtensionTypeInfos(string, ref TExecuteContext)

Declaration

IIpcListExtensionTypeInfo GetExtensionTypeInfos(string ExtensionTypeGroup, ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
string	ExtensionTypeGroup
TExecuteContext	ExecuteContext

Returns

Type	Description
IIpcListExtensionTypeInfo

GetExtensionTypeInfosFromLibrary(string, ref TExecuteContext)

Declaration

IIpcListExtensionTypeInfo GetExtensionTypeInfosFromLibrary(string LibraryPath, ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
string	LibraryPath
TExecuteContext	ExecuteContext

Returns

Type	Description
IIpcListExtensionTypeInfo

GetFieldInherited(TStorageType, string, TStorageField, ref TExecuteContext)

Declaration

bool GetFieldInherited(TStorageType StorageType, string EntityIdent, TStorageField field, ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
TStorageType	StorageType
string	EntityIdent
TStorageField	field
TExecuteContext	ExecuteContext

Returns

Type	Description
bool

GetInstanceId()

Get unique identifier of current instance (used in IPC messages)

Declaration

string GetInstanceId()

Returns

Type	Description
string

GetLibrariesInfo()

Get information about all registered libraries

Declaration

IIpcListExtensionLibraryInfo GetLibrariesInfo()

Returns

Type	Description
IIpcListExtensionLibraryInfo

GetLibraryDisabled(TStorageType, string, ref TExecuteContext)

Declaration

bool GetLibraryDisabled(TStorageType StorageType, string LibraryPath, ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
TStorageType	StorageType
string	LibraryPath
TExecuteContext	ExecuteContext

Returns

Type	Description
bool

GetLibraryInfo(string, ref TExecuteContext)

Declaration

IIpcExtensionLibraryInfo GetLibraryInfo(string ExtensionTypeId, ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
string	ExtensionTypeId
TExecuteContext	ExecuteContext

Returns

Type	Description
IIpcExtensionLibraryInfo

GetLibraryLoaded(string, ref TExecuteContext)

Declaration

bool GetLibraryLoaded(string LibraryPath, ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
string	LibraryPath
TExecuteContext	ExecuteContext

Returns

Type	Description
bool

GetLibraryStorages(string, ref TExecuteContext)

Declaration

IListInteger GetLibraryStorages(string LibraryPath, ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
string	LibraryPath
TExecuteContext	ExecuteContext

Returns

Type	Description
IListInteger

GetPendingDeletionLibraries()

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

IIpcListExtensionLibraryInfo GetPendingDeletionLibraries()

Returns

Type	Description
IIpcListExtensionLibraryInfo

GetSingletonExtension(string, ref TExecuteContext)

Declaration

IIpcExtension GetSingletonExtension(string ExtensionTypeId, ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
string	ExtensionTypeId
TExecuteContext	ExecuteContext

Returns

Type	Description
IIpcExtension

RegisterLibrary(TStorageType, string, ref TExecuteContext)

Declaration

IIpcExtensionLibraryInfo RegisterLibrary(TStorageType StorageType, string DescriptionFilePath, ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
TStorageType	StorageType
string	DescriptionFilePath
TExecuteContext	ExecuteContext

Returns

Type	Description
IIpcExtensionLibraryInfo

RegisterLibraryFromFolder(TStorageType, string, out bool, ref TExecuteContext)

Declaration

IIpcExtensionLibraryInfo RegisterLibraryFromFolder(TStorageType StorageType, string FolderPath, out bool needReload, ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
TStorageType	StorageType
string	FolderPath
bool	needReload
TExecuteContext	ExecuteContext

Returns

Type	Description
IIpcExtensionLibraryInfo

ReloadStorage(TStorageType, ref TExecuteContext)

Declaration

void ReloadStorage(TStorageType StorageType, ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
TStorageType	StorageType
TExecuteContext	ExecuteContext

RemoveExtension(TStorageType, string, string, ref TExecuteContext)

Declaration

void RemoveExtension(TStorageType StorageType, string LibraryPath, string ExtensionTypeId, ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
TStorageType	StorageType
string	LibraryPath
string	ExtensionTypeId
TExecuteContext	ExecuteContext

RemoveExtensionSetting(TStorageType, string, string, ref TExecuteContext)

Declaration

void RemoveExtensionSetting(TStorageType StorageType, string ExtensionTypeId, string Key, ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
TStorageType	StorageType
string	ExtensionTypeId
string	Key
TExecuteContext	ExecuteContext

SetExtensionDisabled(TStorageType, string, bool, ref TExecuteContext)

Declaration

void SetExtensionDisabled(TStorageType StorageType, string ExtensionTypeId, bool Disabled, ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
TStorageType	StorageType
string	ExtensionTypeId
bool	Disabled
TExecuteContext	ExecuteContext

SetExtensionSetting(TStorageType, string, string, string, ref TExecuteContext)

Declaration

void SetExtensionSetting(TStorageType StorageType, string ExtensionTypeId, string Key, string Value, ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
TStorageType	StorageType
string	ExtensionTypeId
string	Key
string	Value
TExecuteContext	ExecuteContext

SetFieldInherited(TStorageType, string, TStorageField, ref TExecuteContext)

Declaration

void SetFieldInherited(TStorageType StorageType, string EntityIdent, TStorageField field, ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
TStorageType	StorageType
string	EntityIdent
TStorageField	field
TExecuteContext	ExecuteContext

SetLibraryDisabled(TStorageType, string, bool, ref TExecuteContext)

Declaration

void SetLibraryDisabled(TStorageType StorageType, string LibraryPath, bool Disabled, ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
TStorageType	StorageType
string	LibraryPath
bool	Disabled
TExecuteContext	ExecuteContext

UnRegisterLibrary(string, ref TExecuteContext)

Declaration

void UnRegisterLibrary(string LibraryPath, ref TExecuteContext ExecuteContext)

Parameters

Type	Name	Description
string	LibraryPath
TExecuteContext	ExecuteContext