Skip to main content
View as Markdown

IEDMS_SearchTemplatesService interface

No description yet.

public interface IEDMS_SearchTemplatesService

Namespace: DXP · Assembly: Altium.SDK.Interfaces

Methods​

MethodReturnsDescription
AddSearchTemplatebool
AddSharingbool
CreateSearchTemplateIEDMS_SearchTemplate
CreateSearchTemplateHeadIEDMS_SearchTemplateHead
CreateSearchTemplateSharingIEDMS_SearchTemplateSharing
DeleteSearchTemplatebool
DeleteSharingbool
GetSearchTemplateByGUIDIEDMS_SearchTemplate
GetSearchTemplatesIEDMS_SearchTemplate
GetSearchTemplatesCountint
GetSearchTemplateSharingbool
HasPermissionOnTemplatebool
LoadSearchTemplatesbool
UpdateSearchTemplatebool

AddSearchTemplate​

No description yet.

bool AddSearchTemplate(IEDMS_SearchTemplate argTemplate, out string argTemplateGUID, out string argErrorMsg);
bool AddSearchTemplate(object argTemplate, out string argTemplateGUID, out string argErrorMsg);
ParameterTypePassing
argTemplateIEDMS_SearchTemplatevalue
argTemplateGUIDstringout
argErrorMsgstringout

Returns: bool

The first overload is an extension method of IEDMS_SearchTemplatesServiceHelper (using DXP;) with typed parameters; the second is declared by the interface.

AddSharing​

No description yet.

bool AddSharing(IEDMS_SearchTemplateSharing argTemplateSharing, out string argErrorMsg);
bool AddSharing(object argTemplateSharing, out string argErrorMsg);
ParameterTypePassing
argTemplateSharingIEDMS_SearchTemplateSharingvalue
argErrorMsgstringout

Returns: bool

The first overload is an extension method of IEDMS_SearchTemplatesServiceHelper (using DXP;) with typed parameters; the second is declared by the interface.

CreateSearchTemplate​

No description yet.

IEDMS_SearchTemplate CreateSearchTemplate();

Returns: IEDMS_SearchTemplate

Extension method of IEDMS_SearchTemplatesServiceHelper (using DXP;).

CreateSearchTemplateHead​

No description yet.

IEDMS_SearchTemplateHead CreateSearchTemplateHead();

Returns: IEDMS_SearchTemplateHead

Extension method of IEDMS_SearchTemplatesServiceHelper (using DXP;).

CreateSearchTemplateSharing​

No description yet.

IEDMS_SearchTemplateSharing CreateSearchTemplateSharing();

Returns: IEDMS_SearchTemplateSharing

Extension method of IEDMS_SearchTemplatesServiceHelper (using DXP;).

DeleteSearchTemplate​

No description yet.

bool DeleteSearchTemplate(IEDMS_SearchTemplate argTemplate, out string argErrorMsg);
bool DeleteSearchTemplate(object argTemplate, out string argErrorMsg);
ParameterTypePassing
argTemplateIEDMS_SearchTemplatevalue
argErrorMsgstringout

Returns: bool

The first overload is an extension method of IEDMS_SearchTemplatesServiceHelper (using DXP;) with typed parameters; the second is declared by the interface.

DeleteSharing​

No description yet.

bool DeleteSharing(IEDMS_SearchTemplateSharing argTemokateSharing, out string argErrorMsg);
bool DeleteSharing(object argTemokateSharing, out string argErrorMsg);
ParameterTypePassing
argTemokateSharingIEDMS_SearchTemplateSharingvalue
argErrorMsgstringout

Returns: bool

The first overload is an extension method of IEDMS_SearchTemplatesServiceHelper (using DXP;) with typed parameters; the second is declared by the interface.

GetSearchTemplateByGUID​

No description yet.

IEDMS_SearchTemplate GetSearchTemplateByGUID(string argTemplateGUID, out string argErrorMsg);
ParameterTypePassing
argTemplateGUIDstringvalue
argErrorMsgstringout

Returns: IEDMS_SearchTemplate

Extension method of IEDMS_SearchTemplatesServiceHelper (using DXP;).

GetSearchTemplates​

No description yet.

IEDMS_SearchTemplate GetSearchTemplates(int argIndex);
ParameterTypePassing
argIndexintvalue

Returns: IEDMS_SearchTemplate

Extension method of IEDMS_SearchTemplatesServiceHelper (using DXP;).

GetSearchTemplatesCount​

No description yet.

int GetSearchTemplatesCount();

Returns: int

GetSearchTemplateSharing​

No description yet.

bool GetSearchTemplateSharing(string argTemplateGUID, IInterfaceList argSharingList, out string argErrorMsg);
bool GetSearchTemplateSharing(string argTemplateGUID, object argSharingList, out string argErrorMsg);
ParameterTypePassing
argTemplateGUIDstringvalue
argSharingListIInterfaceListvalue
argErrorMsgstringout

Returns: bool

The first overload is an extension method of IEDMS_SearchTemplatesServiceHelper (using DXP;) with typed parameters; the second is declared by the interface.

HasPermissionOnTemplate​

No description yet.

bool HasPermissionOnTemplate(string argTemplateGUID, int argAccessRights, out string argErrorMsg);
ParameterTypePassing
argTemplateGUIDstringvalue
argAccessRightsintvalue
argErrorMsgstringout

Returns: bool

LoadSearchTemplates​

No description yet.

bool LoadSearchTemplates(bool argForceRefresh, out string argErrorMsg);
ParameterTypePassing
argForceRefreshboolvalue
argErrorMsgstringout

Returns: bool

UpdateSearchTemplate​

No description yet.

bool UpdateSearchTemplate(IEDMS_SearchTemplate argTemplate, out string argErrorMsg);
bool UpdateSearchTemplate(object argTemplate, out string argErrorMsg);
ParameterTypePassing
argTemplateIEDMS_SearchTemplatevalue
argErrorMsgstringout

Returns: bool

The first overload is an extension method of IEDMS_SearchTemplatesServiceHelper (using DXP;) with typed parameters; the second is declared by the interface.

Returned by​

IEDMS_DXPServerManager.GetSearchTemplatesService