Altova StyleVision Server 2024

Navigation: StyleVision Server API > API-Referenz

COM und .NET

Die StyleVisionServer API stellt die Schnittstelle IServer, zur Verfügung, über die Sie eine neue StyleVision Server-Objektinstanz erstellen und Zugriff auf StyleVision Server erhalten.

Die Schnittstelle IServer hat die folgenden Methoden und Parameter.

Methoden

AddParameter

Weist einem in der PXF-Datei definierten Parameter einen Wert zu.

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

Löscht die Liste der Parameter.

void ClearParameterList()

C++

HRESULT ClearParameterList();

Sub ClearParameterList()

Generate

Generiert anhand der mit TransfPath definierten PXF-Datei eine oder mehrere Ausgabedateien (HTML, PDF, RTF, und/oder DOCX). Der Befehl transformiert die XML-Input-Datei (in der PXF-Datei der XML-Arbeitsdatei) anhand des in der PXF-Datei enthaltenen XSLT-Dokuments. Gibt bei Erfolg TRUE, andernfalls FALSE zurück.

bool Generate(string bstrTransfPath)

C++

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

Function Generate(ByVal bstrTransfPath As String) As Boolean

Eigenschaften

APIMajorVersion

Ruft die Hauptversion der StyleVision Server API ab. Sie unterscheidet sich eventuell von der Produktversion, wenn die API mit einem anderen Server verbunden ist.

int APIMajorVersion { get; }

C++

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

ReadOnly Property APIMajorVersion As Integer

APIMinorVersion

Ruft die Nebenversion der StyleVision Server API ab. Sie unterscheidet sich eventuell von der Produktversion, wenn die API mit einem anderen Server verbunden ist.

int APIMinorVersion { get; }

C++

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

ReadOnly Property APIMinorVersion As Integer

APIServicePackVersion

Ruft die Service Pack-Version der StyleVision Server API ab. Sie unterscheidet sich eventuell von der Produktversion, wenn die API mit einem anderen Server verbunden ist.

int APIServicePackVersion { get; }

C++

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

ReadOnly Property APIServicePackVersion As Integer

InputXML

Definiert den Namen und Pfad der zu verarbeitenden XML-Datei (der XML-Arbeitsdatei in der PXF-Datei).

string InputXML { set; }

C++

HRESULT InputXML([in] BSTR bstrPath );

Property InputXML As String

Is64Bit

Gibt TRUE zurück, wenn der StyleVision Server-Prozessor eine ausführbare 64-Bit-Datei ist.

bool Is64Bit { get; }

C++

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

ReadOnly Property Is64Bit As Boolean

LastExecutionMessage

Ruft die beim letzten Generate-Befehl erhaltene Meldung auf.

string LastExecutionMessage { get; }

C++

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

ReadOnly Property LastExecutionMessage As String

MajorVersion

Ruft die Hauptversion von StyleVision Server ab.

int MajorVersion { get; }

C++

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

ReadOnly Property MajorVersion As Integer

MinorVersion

Ruft die Nebenversion von StyleVision Server ab.

int MinorVersion { get; }

C++

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

ReadOnly Property MinorVersion As Integer

OutputDOCX

Definiert den Namen und Pfad der DOCX-Ausgabedatei.

string OutputDOCX { set; }

C++

HRESULT OutputDOCX([in] BSTR bstrPath );

Property OutputDOCX As String

OutputFO

Definiert den Namen und Pfad der FO-Ausgabedatei.

string OutputFO { set; }

C++

HRESULT OutputFO([in] BSTR bstrPath );

Property OutputFO As String

OutputHTML

Definiert den Namen und Pfad der HTML-Ausgabedatei.

string OutputHTML { set; }

C++

HRESULT OutputHTML([in] BSTR bstrPath );

Property OutputHTML As String

OutputPDF

Definiert den Namen und Pfad der PDF-Ausgabedatei.

string OutputPDF { set; }

C++

HRESULT OutputPDF([in] BSTR bstrPath );

Property OutputPDF As String

OutputRTF

Definiert den Namen und Pfad der RTF-Ausgabedatei.

string OutputRTF { set; }

C++

HRESULT OutputRTF([in] BSTR bstrPath );

Property OutputRTF As String

OutputText

Definiert den Namen und Pfad der Textausgabedatei.

string OutputText { set; }

C++

HRESULT OutputRTF([in] BSTR bstrPath );

Property OutputRTF As String

ProductName

Ruft den Namen des Produkts ab: "StyleVision Server"

string ProductName { get; }

C++

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

ReadOnly Property ProductName As String

ProductNameAndVersion

Ruft den vollständigen Namen des Produkts einschließlich Versionsnummer ab: "StyleVision Server 2014r2 sp1 (x64)".

string ProductNameAndVersion { get; }

C++

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

ReadOnly Property ProductNameAndVersion As String

ServerPath

Ruft den Pfad zur ausführbaren StyleVision Server Datei ab oder definiert ihn.

string ServerPath { set; get; }

C++

HRESULT ServerPath([in] BSTR bstrServerFile );

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

Property ServerPath As String

ServicePackVersion

Ruft die Service Pack-Version von StyleVision Server ab (z.B.: 1 für Altova StyleVision Server 2014 r2 sp1 (x64).)

int ServicePackVersion { get; }

C++

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

ReadOnly Property ServicePackVersion As Integer

WhereClause

Definiert eine SQL WHERE-Klausel, mit der festgelegt wird, welche Zeilen einer DB-XML-Schemaquelle verarbeitet werden sollen.

string WhereClause { set; }

C++

HRESULT WhereClause([in] BSTR bstrPath );

Property WhereClause As String

WorkingDirectory

Ruft das aktuelle Verzeichnis für laufende Aufträge ab oder definiert dieses. Relative Pfade werden anhand des Arbeitsverzeichnisses ausgewertet.

string WorkingDirectory { set; get; }

C++

HRESULT WorkingDirectory([in] BSTR bstrWorkingDirectory );

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

Property WorkingDirectory As String