Altova StyleVision Server 2024

Navigation: StyleVision Server API > Référence API

COM et .NET

L'API StyleVisionServer expose l'interface IServer, qui crée une nouvelle instance d'objet StyleVision Server, et fournit un accès à StyleVision Server.

L'interface IServer a les méthodes et les propriétés suivantes.

Méthodes

AddParameter

Assigne une valeur à un paramètre défini dans le fichier PXF.

void AddParameter(string bstrName, string bstrValue)

C++

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

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

ClearParameterList

Efface la liste des paramètres.

void ClearParameterList()

C++

HRESULT ClearParameterList();

Sub ClearParameterList()

Generate

Génère un ou plusieurs fichiers de sortie (HTML, PDF, RTF, et/ou DOCX) en utilisant le fichier PXF spécifié avec TransfPath. Il transforme le fichier XML d'entrée (Working XML File dans le fichier PXF) en utilisant le document XSLT contenu dans le fichier PXF. Retourne TRUE en cas de succès ; FALSE autrement.

bool Generate(string bstrTransfPath)

C++

HRESULT Generate( [in] BSTR bstrTransfPath, [out, retval] VARIANT_BOOL* pbSuccess );

Function Generate(ByVal bstrTransfPath As String) As Boolean

Propriétés

APIMajorVersion

Obtient la version majeure de l'API StyleVision Server. Elle peut être différente de la version de produit si l'API est connectée à un autre serveur.

int APIMajorVersion { get; }

C++

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

ReadOnly Property APIMajorVersion As Integer

APIMinorVersion

Obtient la version mineure de l'API StyleVision Server. Elle peut être différente de la version de produit si l'API est connectée à un autre serveur.

int APIMinorVersion { get; }

C++

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

ReadOnly Property APIMinorVersion As Integer

APIServicePackVersion

Obtient la version du service pack de l'API StyleVision Server. Elle peut être différente de la version de produit si l'API est connectée à un autre serveur.

int APIServicePackVersion { get; }

C++

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

ReadOnly Property APIServicePackVersion As Integer

InputXML

Définit le chemin et le nom du fichier XML à traiter (le Working XML File dans le fichier PXF).

string InputXML { set; }

C++

HRESULT InputXML([in] BSTR bstrPath );

Property InputXML As String

Is64Bit

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

bool Is64Bit { get; }

C++

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

ReadOnly Property Is64Bit As Boolean

LastExecutionMessage

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

string LastExecutionMessage { get; }

C++

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

ReadOnly Property LastExecutionMessage As String

MajorVersion

Obtient la version majeure de StyleVision Server.

int MajorVersion { get; }

C++

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

ReadOnly Property MajorVersion As Integer

MinorVersion

Obtient la version mineure de StyleVision Server.

int MinorVersion { get; }

C++

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

ReadOnly Property MinorVersion As Integer

OutputDOCX

Définit le chemin et le nom du fichier de sortie DOCX.

string OutputDOCX { set; }

C++

HRESULT OutputDOCX([in] BSTR bstrPath );

Property OutputDOCX As String

OutputFO

Définit le chemin et le nom du fichier de sortie FO.

string OutputFO { set; }

C++

HRESULT OutputFO([in] BSTR bstrPath );

Property OutputFO As String

OutputHTML

Définit le chemin et le nom du fichier de sortie HTML.

string OutputHTML { set; }

C++

HRESULT OutputHTML([in] BSTR bstrPath );

Property OutputHTML As String

OutputPDF

Définit le chemin et le nom du fichier de sortie PDF.

string OutputPDF { set; }

C++

HRESULT OutputPDF([in] BSTR bstrPath );

Property OutputPDF As String

OutputRTF

Définit le chemin et le nom du fichier de sortie RTF.

string OutputRTF { set; }

C++

HRESULT OutputRTF([in] BSTR bstrPath );

Property OutputRTF As String

OutputText

Définit le chemin et le nom du fichier de sortie texte.

string OutputText { set; }

C++

HRESULT OutputText([in] BSTR bstrPath );

Property OutputText As String

ProductName

Obtient le nom du produit : "StyleVision Server"

string ProductName { get; }

C++

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

ReadOnly Property ProductName As String

ProductNameAndVersion

Obtient le nom complet du produit, y compris le numéro de version : "StyleVision Server 2014r2 sp1 (x64)".

string ProductNameAndVersion { get; }

C++

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

ReadOnly Property ProductNameAndVersion As String

ServerPath

Obtient ou définit le chemin vers l'exécutable StyleVision Server.

string ServerPath { set; get; }

C++

HRESULT ServerPath([in] BSTR bstrServerFile );

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

Property ServerPath As String

ServicePackVersion

Obtient la version du pack de service de StyleVision Server (par exemple : 1 pour Altova StyleVision Server 2014 r2 sp1 (x64).)

int ServicePackVersion { get; }

C++

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

ReadOnly Property ServicePackVersion As Integer

WhereClause

Définit une clause SQL WHERE qui détermine les lignes d'une source de schéma DB-XML à traiter.

string WhereClause { set; }

C++

HRESULT WhereClause([in] BSTR bstrPath );

Property WhereClause As String

WorkingDirectory

Obtient ou définit le répertoire actuel pour des tâches en cours. Les chemins relatifs sont évalués par rapport au répertoire de travail.

string WorkingDirectory { set; get; }

C++

HRESULT WorkingDirectory([in] BSTR bstrWorkingDirectory );

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

Property WorkingDirectory As String