IServer

www.altova.com Imprimer cette rubrique Page précédente Un niveau supérieur Page suivante

Accueil >  MapForce Server API > API Reference (COM, .NET) > Interfaces >

IServer

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

 

Si vous utilisez C++ sous une plateforme COM, le nom de l’interface principale est IServer. Si vous utilisez un langage .NET comme C# ou VB.NET, le nom de l’interface principale est Server.

 

Propriétés

Nom

Description

APIMajorVersion

Read-only.

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.

APIMinorVersion

Read-only.

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.

APIServicePackVersion

Read-only.

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.

Is64Bit

Read-only.

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

LastExecutionMessage

Read-only.

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

MajorVersion

Read-only.

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

MinorVersion

Read-only.

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

ProductName

Read-only.

Obtient le nom du produit (par exemple, "Altova MapForce Server").

ProductNameAndVersion

Read-only.

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

ServerPath

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

ServicePackVersion

Read-only.

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

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).

 

Méthodes

Nom

Description

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.

ClearOptions

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

ClearParameterList

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

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.

Run

Exécute un fichier MapForce Server Execution (fichier .mfx). Retourne true en cas de succès ; sinon, false.

SetOption

Définit une option avant d’exécuter le mappage. Le premier argument spécifie le nom de l’option ; 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 Altova Global Resources). Les options prises en charge actuellement sont les suivantes :

 

globalresourcefile (ou gr) - Un chemin de fichier Ressource Globale . (Lorsque cette option est spécifiée, un nom de configuration de Ressource Globale doit aussi être spécifié, voir item suivant).
globalresourceconfig (ou gc) - Un nom de configuration de Ressource Globale. (Lorsque cette option est spécifiée, un chemin de fichier de Ressource Globale doit aussi être spécifié, voir item précédent).
catalog - Le chemin vers un fichier RootCatalog.xml personnalisé. Cette option vous permet de spécifier un fichier de catalogue personnalisé utilisé pour résoudre des URL utilisés par le mappage. Le catalogue par défaut se trouve dans le sous-directoire etc du répertoire d’installation du programme.
taxonomy-package - Le chemin vers un paquet de taxonomie XBRL personnalisé, si un tel pack est requis par le mappage.
taxonomy-packages-config-file - Le chemin vers une configuration de taxonomie XBRL personnalisée, si un tel pack est requis par le mappage.

 

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

 

Exemples

Voir les exemples suivants qui illustrent comment initialiser et exécuter MapForce Server dans des langages différents :

 

Exemple C++
Exemple C#
Exemple VBScript
Exemple VB.NET.

© 2019 Altova GmbH