IServerRecord interface

This interface extracts the servers installation files information from the \System folder which has a list of server installation files. That is each server installation file (with an INS extension) correspond to a IServerRecord itnerface.

public interface IServerRecord

Namespace: DXP · Assembly: Altium.SDK.Interfaces

Remarks

Since this IServerRecord interface is inside the Client object, invoke IClient.GetServerRecordCount to get the number of server installation files, and then assign the result of IClient.GetServerRecord to a IServerRecord variable where you can retrieve data associated with an installation file.

To find more information about each server module installed in Altium Designer, invoke the IClient.GetServerModule interface.

Methods

Method	Returns	Description
GetCommand	IServerProcess	The method returns the IServerProcess interface.
GetCommandCount	int	The method returns the number of commands (Process launchers) this server supports.
GetCopyRight	string	The method returns the copyright string.
GetDate	string	The method returns the date string associated with the server installation file.
GetDescription	string	The method returns the description string.
GetDocumentFilter	void
GetDocumentFilterCount	int
GetExePath	string	The method returns the path to the server file.
GetGeneralInfo	string	The method returns the general info string for the server record associated with a server.
GetInsPath	string	The method returns the path to the installation file.
GetIsDocumentWizard	bool
GetName	string	The method returns the name of the server.
GetPanelInfo	IServerPanelInfo	The method returns the indexed panel information.
GetPanelInfoByName	IServerPanelInfo	The method returns the panel information interface by the panel name.
GetPanelInfoCount	int	The method returns the number of panels used for the server module.
GetRCSFilePath	string	The method returns the path to the resources file.
GetServerFileExist	bool	The method returns the Boolean value whether the server file (with a DLL) exists or not.
GetSupportsDDBRead	bool
GetSupportsDDBWrite	bool
GetSystemExtension	bool	The method returns the file system extension string.
GetVersion	string	The method returns the version string associated with the server installation file.
GetWindowKind	IServerWindowKind	The method returns the IServerWindowKind interface.
GetWindowKindByName	IServerWindowKind	The method returns the IServerWindowKind interface depending on the DocumentKind Name parameter.
GetWindowKindCount	int	The method returns the number of document kinds the server supports.

GetCommand

The method returns the IServerProcess interface. Used in conjunction with the GetCommandCount method.

IServerProcess GetCommand(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: IServerProcess

Extension method of IServerRecordHelper (using DXP;).

GetCommandCount

The method returns the number of commands (Process launchers) this server supports. Used in conjunction with the GetCommand method

int GetCommandCount();

Returns: int

GetCopyRight

The method returns the copyright string.

string GetCopyRight();

Returns: string

GetDate

The method returns the date string associated with the server installation file.

string GetDate();

Returns: string

GetDescription

The method returns the description string.

string GetDescription();

Returns: string

GetDocumentFilter

No description yet.

void GetDocumentFilter(int argIndex, out string argKind, out string argFilter);

Parameter	Type	Passing
argIndex	int	value
argKind	string	out
argFilter	string	out

Returns: nothing (void)

GetDocumentFilterCount

No description yet.

int GetDocumentFilterCount();

Returns: int

GetExePath

The method returns the path to the server file.

string GetExePath();

Returns: string

GetGeneralInfo

The method returns the general info string for the server record associated with a server.

string GetGeneralInfo();

Returns: string

GetInsPath

The method returns the path to the installation file.

string GetInsPath();

Returns: string

GetIsDocumentWizard

No description yet.

bool GetIsDocumentWizard();

Returns: bool

GetName

The method returns the name of the server.

string GetName();

Returns: string

GetPanelInfo

The method returns the indexed panel information. This is to be used in conjunction with the GetPanelInfoCount method.

IServerPanelInfo GetPanelInfo(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: IServerPanelInfo

Extension method of IServerRecordHelper (using DXP;).

GetPanelInfoByName

The method returns the panel information interface by the panel name.

IServerPanelInfo GetPanelInfoByName(string argName);

Parameter	Type	Passing
argName	string	value

Returns: IServerPanelInfo

Extension method of IServerRecordHelper (using DXP;).

GetPanelInfoCount

The method returns the number of panels used for the server module. This is to be used in conjunction with the GetPanelInfo method.

int GetPanelInfoCount();

Returns: int

GetRCSFilePath

The method returns the path to the resources file.

string GetRCSFilePath();

Returns: string

GetServerFileExist

The method returns the Boolean value whether the server file (with a DLL) exists or not.

bool GetServerFileExist();

Returns: bool

GetSupportsDDBRead

No description yet.

bool GetSupportsDDBRead();

Returns: bool

GetSupportsDDBWrite

No description yet.

bool GetSupportsDDBWrite();

Returns: bool

GetSystemExtension

The method returns the file system extension string.

bool GetSystemExtension();

Returns: bool

GetVersion

The method returns the version string associated with the server installation file.

string GetVersion();

Returns: string

Example: Find the version of the Client server.

using DXP;

IClient client = DXP.GlobalVars.Client;
string version = "";
int recordCount = client.GetServerRecordCount();
for (int i = 0; i < recordCount; i++)
{
    IServerRecord serverRecord = client.GetServerRecord(i);
    if (serverRecord.GetName() == "Client")
    {
        version = serverRecord.GetVersion();
        break;
    }
}

GetWindowKind

The method returns the IServerWindowKind interface. Used in conjunction with the GetWindowKindCount method.

IServerWindowKind GetWindowKind(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: IServerWindowKind

Extension method of IServerRecordHelper (using DXP;).

GetWindowKindByName

The method returns the IServerWindowKind interface depending on the DocumentKind Name parameter.

IServerWindowKind GetWindowKindByName(string argName);

Parameter	Type	Passing
argName	string	value

Returns: IServerWindowKind

Extension method of IServerRecordHelper (using DXP;).

See also: IServerWindowKind

GetWindowKindCount

The method returns the number of document kinds the server supports.

int GetWindowKindCount();

Returns: int

Returned by

IClient.GetServerRecord, IClient.GetServerRecordByFeature, IClient.GetServerRecordByName, IServerWindowKind.GetServerRecord