Class ExtensionManagerHelper

Helper functions for IIpcExtensionManager

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: CAMIPC.DotnetHelper

Assembly: CAMIPC.DotnetHelper.dll

Syntax

public static class ExtensionManagerHelper

Methods

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

Adds an extension

Declaration

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

Parameters

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

CreateExtension(ComWrapper<IIpcExtensionManager>, string)

Creates an extension by its unique identifier

Declaration

public static ComWrapper<IIpcExtension> CreateExtension(this ComWrapper<IIpcExtensionManager> managerCom, string extensionTypeId)

Parameters

Type	Name	Description
ComWrapper<IIpcExtensionManager>	managerCom
string	extensionTypeId

Returns

Type	Description
ComWrapper<IIpcExtension>

CreateExtensions(ComWrapper<IIpcExtensionManager>, string)

Creates extensions by their unique identifiers

Declaration

public static ComWrapper<IIpcListExtension> CreateExtensions(this ComWrapper<IIpcExtensionManager> managerCom, string extensionTypeIds)

Parameters

Type	Name	Description
ComWrapper<IIpcExtensionManager>	managerCom
string	extensionTypeIds

Returns

Type	Description
ComWrapper<IIpcListExtension>

EnumerateExtensionTypeInfos(ComWrapper<IIpcExtensionManager>, string)

Lists all extension type infos for a group. Each item is disposed when the iterator advances.

Declaration

public static IEnumerable<ComWrapper<IIpcExtensionTypeInfo>> EnumerateExtensionTypeInfos(this ComWrapper<IIpcExtensionManager> managerCom, string group)

Parameters

Type	Name	Description
ComWrapper<IIpcExtensionManager>	managerCom
string	group

Returns

Type	Description
IEnumerable<ComWrapper<IIpcExtensionTypeInfo>>

EnumerateLibraries(ComWrapper<IIpcExtensionManager>)

Lists all extension libraries. Each item is disposed when the iterator advances.

Declaration

public static IEnumerable<ComWrapper<IIpcExtensionLibraryInfo>> EnumerateLibraries(this ComWrapper<IIpcExtensionManager> managerCom)

Parameters

Type	Name	Description
ComWrapper<IIpcExtensionManager>	managerCom

Returns

Type	Description
IEnumerable<ComWrapper<IIpcExtensionLibraryInfo>>

EnumeratePendingDeletionLibraries(ComWrapper<IIpcExtensionManager>)

Lists libraries with pending deletion (DLL was locked during UnRegisterLibrary). Each item is disposed when the iterator advances.

Declaration

public static IEnumerable<ComWrapper<IIpcExtensionLibraryInfo>> EnumeratePendingDeletionLibraries(this ComWrapper<IIpcExtensionManager> managerCom)

Parameters

Type	Name	Description
ComWrapper<IIpcExtensionManager>	managerCom

Returns

Type	Description
IEnumerable<ComWrapper<IIpcExtensionLibraryInfo>>

EnumerateTypeGroups(ComWrapper<IIpcExtensionManager>)

Lists all extension type groups

Declaration

public static IEnumerable<string> EnumerateTypeGroups(this ComWrapper<IIpcExtensionManager> managerCom)

Parameters

Type	Name	Description
ComWrapper<IIpcExtensionManager>	managerCom

Returns

Type	Description
IEnumerable<string>

EnumerateTypeInfosFromLibrary(ComWrapper<IIpcExtensionManager>, string)

Lists all extension type infos from a library. Each item is disposed when the iterator advances.

Declaration

public static IEnumerable<ComWrapper<IIpcExtensionTypeInfo>> EnumerateTypeInfosFromLibrary(this ComWrapper<IIpcExtensionManager> managerCom, string libraryPath)

Parameters

Type	Name	Description
ComWrapper<IIpcExtensionManager>	managerCom
string	libraryPath

Returns

Type	Description
IEnumerable<ComWrapper<IIpcExtensionTypeInfo>>

FreeExtension(ComWrapper<IIpcExtensionManager>, long)

Frees the extension by its unique instance identifier

Declaration

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

Parameters

Type	Name	Description
ComWrapper<IIpcExtensionManager>	managerCom
long	extensionInstanceId

FreeLibrary(ComWrapper<IIpcExtensionManager>, string)

Frees the library by its path

Declaration

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

Parameters

Type	Name	Description
ComWrapper<IIpcExtensionManager>	managerCom
string	libraryPath

GetApiDependencies(ComWrapper<IIpcExtensionManager>)

Reference assemblies a built macro must compile against (use for macro .NET References).

Declaration

public static IListString GetApiDependencies(this ComWrapper<IIpcExtensionManager> managerCom)

Parameters

Type	Name	Description
ComWrapper<IIpcExtensionManager>	managerCom

Returns

Type	Description
IListString

GetApiVersion(ComWrapper<IIpcExtensionManager>)

Current CAM Open API version (use as the macro .NET SDK version).

Declaration

public static string GetApiVersion(this ComWrapper<IIpcExtensionManager> managerCom)

Parameters

Type	Name	Description
ComWrapper<IIpcExtensionManager>	managerCom

Returns

Type	Description
string

GetExtension(ComWrapper<IIpcExtensionManager>, long)

Returns the extension by its unique instance identifier

Declaration

public static ComWrapper<IIpcExtension> GetExtension(this ComWrapper<IIpcExtensionManager> managerCom, long extensionInstanceId)

Parameters

Type	Name	Description
ComWrapper<IIpcExtensionManager>	managerCom
long	extensionInstanceId

Returns

Type	Description
ComWrapper<IIpcExtension>

GetExtensionDisabled(ComWrapper<IIpcExtensionManager>, TStorageType, string)

Returns whether the extension is disabled

Declaration

public static bool GetExtensionDisabled(this ComWrapper<IIpcExtensionManager> managerCom, TStorageType storageType, string extensionIdent)

Parameters

Type	Name	Description
ComWrapper<IIpcExtensionManager>	managerCom
TStorageType	storageType
string	extensionIdent

Returns

Type	Description
bool

GetExtensionSetting(ComWrapper<IIpcExtensionManager>, string, string)

Effective value of an extension setting, resolved across storage levels then manifest default. Returns null when nothing defines the key.

Declaration

public static string? GetExtensionSetting(this ComWrapper<IIpcExtensionManager> managerCom, string extensionTypeId, string key)

Parameters

Type	Name	Description
ComWrapper<IIpcExtensionManager>	managerCom
string	extensionTypeId
string	key

Returns

Type	Description
string

GetExtensionSettingKeys(ComWrapper<IIpcExtensionManager>, string)

Keys of an extension's settings, unioned across all levels and manifest defaults (raw list wrapper).

Declaration

public static ComWrapper<IListString> GetExtensionSettingKeys(this ComWrapper<IIpcExtensionManager> managerCom, string extensionTypeId)

Parameters

Type	Name	Description
ComWrapper<IIpcExtensionManager>	managerCom
string	extensionTypeId

Returns

Type	Description
ComWrapper<IListString>

GetExtensionSettingSourceLevel(ComWrapper<IIpcExtensionManager>, string, string, out bool, out bool)

Storage level that supplies the effective value of a setting (for an "inherited from level X" indicator). found=false when nothing defines the key; fromDefault=true when the value comes from the manifest default, in which case the returned level is meaningless.

Declaration

public static TStorageType GetExtensionSettingSourceLevel(this ComWrapper<IIpcExtensionManager> managerCom, string extensionTypeId, string key, out bool found, out bool fromDefault)

Parameters

Type	Name	Description
ComWrapper<IIpcExtensionManager>	managerCom
string	extensionTypeId
string	key
bool	found
bool	fromDefault

Returns

Type	Description
TStorageType

GetExtensionTypeGroup(ComWrapper<IIpcExtensionManager>, string)

Returns the group info by its unique ident

Declaration

public static ComWrapper<IIpcExtensionTypeGroup> GetExtensionTypeGroup(this ComWrapper<IIpcExtensionManager> managerCom, string groupId)

Parameters

Type	Name	Description
ComWrapper<IIpcExtensionManager>	managerCom
string	groupId

Returns

Type	Description
ComWrapper<IIpcExtensionTypeGroup>

GetExtensionTypeGroups(ComWrapper<IIpcExtensionManager>)

Returns the list of extension type groups (raw list wrapper)

Declaration

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

Parameters

Type	Name	Description
ComWrapper<IIpcExtensionManager>	managerCom

Returns

Type	Description
ComWrapper<IListString>

GetExtensionTypeInfo(ComWrapper<IIpcExtensionManager>, string)

Returns the extension type info by its unique identifier

Declaration

public static ComWrapper<IIpcExtensionTypeInfo> GetExtensionTypeInfo(this ComWrapper<IIpcExtensionManager> managerCom, string extensionTypeId)

Parameters

Type	Name	Description
ComWrapper<IIpcExtensionManager>	managerCom
string	extensionTypeId

Returns

Type	Description
ComWrapper<IIpcExtensionTypeInfo>

GetExtensionTypeInfos(ComWrapper<IIpcExtensionManager>, string)

Returns the list of extension type infos for a group (raw list wrapper)

Declaration

public static ComWrapper<IIpcListExtensionTypeInfo> GetExtensionTypeInfos(this ComWrapper<IIpcExtensionManager> managerCom, string group)

Parameters

Type	Name	Description
ComWrapper<IIpcExtensionManager>	managerCom
string	group

Returns

Type	Description
ComWrapper<IIpcListExtensionTypeInfo>

GetExtensionTypeInfosFromLibrary(ComWrapper<IIpcExtensionManager>, string)

Returns the list of extension type infos from a library (raw list wrapper)

Declaration

public static ComWrapper<IIpcListExtensionTypeInfo> GetExtensionTypeInfosFromLibrary(this ComWrapper<IIpcExtensionManager> managerCom, string libraryPath)

Parameters

Type	Name	Description
ComWrapper<IIpcExtensionManager>	managerCom
string	libraryPath

Returns

Type	Description
ComWrapper<IIpcListExtensionTypeInfo>

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

Returns whether the field is inherited

Declaration

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

Parameters

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

Returns

Type	Description
bool

GetInstanceId(ComWrapper<IIpcExtensionManager>)

Get unique identifier of current instance

Declaration

public static string GetInstanceId(this ComWrapper<IIpcExtensionManager> managerCom)

Parameters

Type	Name	Description
ComWrapper<IIpcExtensionManager>	managerCom

Returns

Type	Description
string

GetLibrariesInfo(ComWrapper<IIpcExtensionManager>)

Returns the list of libraries (raw list wrapper)

Declaration

public static ComWrapper<IIpcListExtensionLibraryInfo> GetLibrariesInfo(this ComWrapper<IIpcExtensionManager> managerCom)

Parameters

Type	Name	Description
ComWrapper<IIpcExtensionManager>	managerCom

Returns

Type	Description
ComWrapper<IIpcListExtensionLibraryInfo>

GetLibraryDisabled(ComWrapper<IIpcExtensionManager>, TStorageType, string)

Returns whether the library is disabled

Declaration

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

Parameters

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

Returns

Type	Description
bool

GetLibraryInfo(ComWrapper<IIpcExtensionManager>, string)

Get extension library properties by unique ident of extension inside it

Declaration

public static ComWrapper<IIpcExtensionLibraryInfo> GetLibraryInfo(this ComWrapper<IIpcExtensionManager> managerCom, string extensionTypeId)

Parameters

Type	Name	Description
ComWrapper<IIpcExtensionManager>	managerCom
string	extensionTypeId

Returns

Type	Description
ComWrapper<IIpcExtensionLibraryInfo>

GetLibraryLoaded(ComWrapper<IIpcExtensionManager>, string)

Returns whether the library is loaded

Declaration

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

Parameters

Type	Name	Description
ComWrapper<IIpcExtensionManager>	managerCom
string	libraryPath

Returns

Type	Description
bool

GetLibraryStorages(ComWrapper<IIpcExtensionManager>, string)

Get all storages, where a library has non-inherited values

Declaration

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

Parameters

Type	Name	Description
ComWrapper<IIpcExtensionManager>	managerCom
string	libraryPath

Returns

Type	Description
ComWrapper<IListInteger>

RegisterLibrary(ComWrapper<IIpcExtensionManager>, TStorageType, string)

Registers a library

Declaration

public static ComWrapper<IIpcExtensionLibraryInfo> RegisterLibrary(this ComWrapper<IIpcExtensionManager> managerCom, TStorageType storageType, string descriptionFilePath)

Parameters

Type	Name	Description
ComWrapper<IIpcExtensionManager>	managerCom
TStorageType	storageType
string	descriptionFilePath

Returns

Type	Description
ComWrapper<IIpcExtensionLibraryInfo>

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

Registers a library from folder

Declaration

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

Parameters

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

Returns

Type	Description
ComWrapper<IIpcExtensionLibraryInfo>

ReloadStorage(ComWrapper<IIpcExtensionManager>, TStorageType)

Reloads a storage

Declaration

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

Parameters

Type	Name	Description
ComWrapper<IIpcExtensionManager>	managerCom
TStorageType	storageType

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

Removes an extension

Declaration

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

Parameters

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

RemoveExtensionSetting(ComWrapper<IIpcExtensionManager>, TStorageType, string, string)

Removes an extension setting from one storage level.

Declaration

public static void RemoveExtensionSetting(this ComWrapper<IIpcExtensionManager> managerCom, TStorageType storageType, string extensionTypeId, string key)

Parameters

Type	Name	Description
ComWrapper<IIpcExtensionManager>	managerCom
TStorageType	storageType
string	extensionTypeId
string	key

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

Sets whether the extension is disabled

Declaration

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

Parameters

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

SetExtensionSetting(ComWrapper<IIpcExtensionManager>, TStorageType, string, string, string)

Writes an extension setting into one storage level (secret keys stay in-session only).

Declaration

public static void SetExtensionSetting(this ComWrapper<IIpcExtensionManager> managerCom, TStorageType storageType, string extensionTypeId, string key, string value)

Parameters

Type	Name	Description
ComWrapper<IIpcExtensionManager>	managerCom
TStorageType	storageType
string	extensionTypeId
string	key
string	value

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

Sets whether the field is inherited

Declaration

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

Parameters

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

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

Sets whether the library is disabled

Declaration

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

Parameters

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

UnRegisterLibrary(ComWrapper<IIpcExtensionManager>, string)

Unregisters a library

Declaration

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

Parameters

Type	Name	Description
ComWrapper<IIpcExtensionManager>	managerCom
string	libraryPath