IServer Interface

www.altova.com Agrandir/Réduire tout Imprimer cette rubrique Un niveau supérieur

Accueil > 

IServer Interface

L'interface IServer crée une instance d'objet de MapForce Server, et fournit l'accès au moteur de MapForce Server. L'interface IServer comporte les membres suivants :

 

Méthodes
Propriétés

 

 

Méthodes

 

Méthode AddParameter

Assigne une valeur à un paramètre défini dans le mappage. Le premier argument spécifie le nom du paramètre tel que défini dans le mappage ; le second argument spécifie la valeur de paramètre.

 

hmtoggle_arrow1C#

void AddParameter(string bstrName, string bstrValue)

 

hmtoggle_arrow1C++

HRESULT AddParameter([in] BSTR bstrName, [in] BSTR bstrValue );

 

hmtoggle_arrow1VB

Sub AddParameter(ByVal bstrName As String, ByVal bstrValue As String)

 

 

Méthode ClearOptions

Supprime la liste des options précédemment définies par la méthode SetOption. Toutes les options définies par le biais de la méthode SetOption sont valides pour la durée de vie de l'objet. Appeler cette méthode si vous souhaitez explicitement effacer toutes les options définies précédemment.

 

hmtoggle_arrow1C#

void ClearOptions()

 

hmtoggle_arrow1C++

HRESULT ClearOptions();

 

hmtoggle_arrow1VB

Sub ClearOptions()

 

 

Méthode ClearParameterList

Supprime la liste des paramètres qui étaient définis précédemment en utilisant la méthode AddParameter.

 

hmtoggle_arrow1C#

void ClearParameterList()

 

hmtoggle_arrow1C++

HRESULT ClearParameterList();

 

hmtoggle_arrow1VB

Sub ClearParameterList()

 

 

Méthode GetOutputParameter

Obtient la sortie de string générée par la dernière commande run. Retourne null si aucune sortie n'est générée. Cette fonction requiert un paramètre de string qui identifie le nom du composant de sortie dans MapForce.

 

hmtoggle_arrow1C#

string GetOutputParameter(string bstrName)

 

hmtoggle_arrow1C++

HRESULT GetOutputParameter([in] BSTR bstrName, [out, retval] BSTR* pbstrValue );

 

hmtoggle_arrow1VB

Function GetOutputParameter(bstrName As String) As String

 

 

Méthode Run

Exécute un fichier MapForce Server Execution (fichier .mfx). Retourne TRUE en cas de réussite ; sinon FALSE.

 

hmtoggle_arrow1C#

bool Run(string bstrMappingPath)

 

hmtoggle_arrow1C++

HRESULT Run( [in] BSTR bstrMappingPath, [out, retval] VARIANT_BOOL* pbSuccess );

 

hmtoggle_arrow1VB

Function Run(ByVal bstrMappingPath As String) As Boolean

 

 

Méthode SetOption

Définit une option avant d'exécuter le mappage. Le premier argument spécifie le nom de l'option, alors que le second argument spécifie la valeur d'option. Cette méthode est particulièrement utile lorsqu'un mappage a été conçu pour consommer des Ressources globales (voir Ressources globales Altova). Les options prises en charge actuellement sont les suivantes :

 

Nom de l'option

Description

globalresourcefile (or gr)

Un chemin de fichier de Ressources globales. (Lorsque cette option est spécifiée, un nom de configuration de Ressources globales doit aussi être spécifié, voir item suivant).

globalresourceconfig (or gc)

Un nom de configuration de Ressources globales. (Lorsque cette option est spécifiée, un chemin de fichier de Ressources globales doit aussi être spécifié, voir item suivant).

catalog

Le chemin vers un fichier personnalisé RootCatalog.xml. Cette option vous permet de spécifier un fichier de catalogue personnalisé utilisé pour résoudre des URL utilisées par le mappage. Le catalogue par défaut se trouve dans le sous-répertoire etc du répertoire d'installation du programme.

taxonomy-package

Le chemin vers un pack de taxonomie XBRL personnalisé, si un chemin est requis par le mappage.

taxonomy-packages-config-file

Le chemin vers une configuration de pack de taxonomie XBRL personnalisé, si une configuration est requise par le mappage.

 

Toutes les options de définies sont valides pour la durée de vie de l'objet. Si vous définissez deux fois une option avec le même nom, l'option précédente sera écrasée. Pour effacer explicitement toutes les options, appeler la méthode ClearOptions().

 

hmtoggle_arrow1C#

void SetOption(ByVal bstrName As String, ByVal bstrValue As String)

 

hmtoggle_arrow1C++

HRESULT SetOption([in] BSTR bstrName, [in] BSTR bstrValue );

 

hmtoggle_arrow1VB

Sub SetOption(ByVal bstrName As String, ByVal bstrValue As String)

 

 

Propriétés

 

Propriété APIMajorVersion

Obtient la version majeure de l'API de MapForce Server. Cela peut différer de la version de produit si l'API est connectée à un autre serveur.

 

hmtoggle_arrow1C#

int APIMajorVersion { get; }

 

hmtoggle_arrow1C++

HRESULT APIMajorVersion([out, retval] INT* pnVal);

 

hmtoggle_arrow1VB

ReadOnly Property APIMajorVersion As Integer

 

 

Propriété APIMinorVersion

Obtient la version mineure de l'API de MapForce Server. Cela peut différer de la version de produit si l'API est connectée à un autre serveur.

 

hmtoggle_arrow1C#

int APIMinorVersion { get; }

 

hmtoggle_arrow1C++

HRESULT APIMinorVersion([out, retval] INT* pnVal);

 

hmtoggle_arrow1VB

ReadOnly Property APIMinorVersion As Integer

 

 

Propriété APIServicePackVersion

Obtient la version de service de l'API MapForce Server. Cela peut différer de la version de produit si l'API est connectée à un autre serveur.

 

hmtoggle_arrow1C#

int APIServicePackVersion { get; }

 

hmtoggle_arrow1C++

HRESULT APIServicePackVersion([out, retval] INT* pnVal);

 

hmtoggle_arrow1VB

ReadOnly Property APIServicePackVersion As Integer

 

 

Propriété Is64Bit

Retourne TRUE si le moteur MapForce Server est un exécutable 64-bit.

 

hmtoggle_arrow1C#

bool Is64Bit { get; }

 

hmtoggle_arrow1C++

HRESULT Is64Bit([out, retval] VARIANT_BOOL* pbVal);

 

hmtoggle_arrow1VB

ReadOnly Property Is64Bit As Boolean

 

 

Propriété LastExecutionMessage

Obtient le message reçu pendant la dernière commande Run.

 

hmtoggle_arrow1C#

string LastExecutionMessage { get; }

 

hmtoggle_arrow1C++

HRESULT LastExecutionMessage([out, retval] BSTR* pbstrResult );

 

hmtoggle_arrow1VB

ReadOnly Property LastExecutionMessage As String

 

 

Propriété MajorVersion

Obtient la version majeure du produit, en tant que nombre des années débutant avec 1998 (par exemple, "16" pour Altova MapForce Server 2014 r2 sp1 (x64)).

 

hmtoggle_arrow1C#

int MajorVersion { get; }

 

hmtoggle_arrow1C++

HRESULT MajorVersion([out, retval] INT* pnVal);

 

hmtoggle_arrow1VB

ReadOnly Property MajorVersion As Integer

 

 

Propriété MinorVersion

Obtient la version mineure du produit (par exemple, "2" pour Altova MapForce Server 2014 r2 sp1 (x64)).

 

hmtoggle_arrow1C#

int MinorVersion { get; }

 

hmtoggle_arrow1C++

HRESULT MinorVersion([out, retval] INT* pnVal);

 

hmtoggle_arrow1VB

ReadOnly Property MinorVersion As Integer

 

 

Propriété ProductName

Obtient le nom du produit (par exemple, "Altova MapForce Server" pour Altova MapForce Server 2014 r2 sp1 (x64)).

 

hmtoggle_arrow1C#

string ProductName { get; }

 

hmtoggle_arrow1C++

HRESULT ProductName([out, retval] BSTR* pstrVal);

 

hmtoggle_arrow1VB

ReadOnly Property ProductName As String

 

 

Propriété ProductNameAndVersion

Obtient le nom complet et la version du produit (par exemple, "Altova MapForce Server 2014 r2 sp1 (x64)").

 

hmtoggle_arrow1C#

string ProductNameAndVersion { get; }

 

hmtoggle_arrow1C++

HRESULT ProductNameAndVersion([out, retval] BSTR* pstrVal);

 

hmtoggle_arrow1VB

ReadOnly Property ProductNameAndVersion As String

 

 

Propriété ServerPath

Obtient ou définit le chemin de l'exécutable MapForce Server.

 

hmtoggle_arrow1C#

string ServerPath { set; get; }

 

hmtoggle_arrow1C++

HRESULT ServerPath([in] BSTR bstrServerFile );

HRESULT ServerPath([out, retval] BSTR* pbstrServerFile );

 

hmtoggle_arrow1VB

Property ServerPath As String

 

 

Propriété ServicePackVersion

Obtient la version de pack de service du produit (par exemple, "1" pour Altova MapForce Server 2014 r2 sp1 (x64)).

 

hmtoggle_arrow1C#

int ServicePackVersion { get; }

 

hmtoggle_arrow1C++

HRESULT ServicePackVersion([out, retval] INT* pnVal);

 

hmtoggle_arrow1VB

ReadOnly Property ServicePackVersion As Integer

 

 

Propriété WorkingDirectory

Obtient ou définit le répertoire actuel pour exécuter les tâches (les chemins relatifs seront évalués par rapport au répertoire de travail).

 

hmtoggle_arrow1C#

string WorkingDirectory { set; get; }

 

hmtoggle_arrow1C++

HRESULT WorkingDirectory([in] BSTR bstrWorkingDirectory );

HRESULT WorkingDirectory([out, retval] BSTR* pbstrWorkingDirectory );

 

hmtoggle_arrow1VB

Property WorkingDirectory As String


© 2019 Altova GmbH