COM und .NET

www.altova.com Alle erweitern/reduzieren Dieses Kapitel drucken Vorherige Seite Eine Ebene nach oben Nächste Seite

Startseite >  Einführung > 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

 

Click to expand/collapseAddParameter

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

 

void AddParameter(string bstrName, string bstrValue)

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

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

 

 

Click to expand/collapseClearParameterList

Löscht die Liste der Parameter.

 

void ClearParameterList()

HRESULT ClearParameterList();

Sub ClearParameterList()

 

 

Click to expand/collapseGenerate

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)

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

Function Generate(ByVal bstrTransfPath As String) As Boolean

 

 

 

 

Eigenschaften

 

Click to expand/collapseAPIMajorVersion

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

 

int APIMajorVersion { get; }

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

ReadOnly Property APIMajorVersion As Integer

 

 

Click to expand/collapseAPIMinorVersion

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

 

int APIMinorVersion { get; }

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

ReadOnly Property APIMinorVersion As Integer

 

 

Click to expand/collapseAPIServicePackVersion

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

 

int APIServicePackVersion { get; }

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

ReadOnly Property APIServicePackVersion As Integer

 

 

Click to expand/collapseInputXML

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

 

string InputXML { set; }

HRESULT InputXML([in] BSTR bstrPath );

Property InputXML As String

 

 

Click to expand/collapseIs64Bit

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

 

bool Is64Bit { get; }

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

ReadOnly Property Is64Bit As Boolean

 

 

Click to expand/collapseLastExecutionMessage

Ruft die beim letzten Generate-Befehl erhaltene Meldung auf.

 

string LastExecutionMessage { get; }

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

ReadOnly Property LastExecutionMessage As String

 

 

Click to expand/collapseMajorVersion

Ruft die Hauptversion von StyleVision Server ab.

 

int MajorVersion { get; }

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

ReadOnly Property MajorVersion As Integer

 

 

Click to expand/collapseMinorVersion

Ruft die Nebenversion von StyleVision Server ab.

 

int MinorVersion { get; }

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

ReadOnly Property MinorVersion As Integer

 

 

Click to expand/collapseOutputDOCX

Definiert den Namen und Pfad der DOCX-Ausgabedatei.

 

string OutputDOCX { set; }

HRESULT OutputDOCX([in] BSTR bstrPath );

Property OutputDOCX As String

 

 

Click to expand/collapseOutputFO

Definiert den Namen und Pfad der FO-Ausgabedatei.

 

string OutputFO { set; }

HRESULT OutputFO([in] BSTR bstrPath );

Property OutputFO As String

 

 

Click to expand/collapseOutputHTML

Definiert den Namen und Pfad der HTML-Ausgabedatei.

 

string OutputHTML { set; }

HRESULT OutputHTML([in] BSTR bstrPath );

Property OutputHTML As String

 

 

Click to expand/collapseOutputPDF

Definiert den Namen und Pfad der PDF-Ausgabedatei.

 

string OutputPDF { set; }

HRESULT OutputPDF([in] BSTR bstrPath );

Property OutputPDF As String

 

 

Click to expand/collapseOutputRTF

Definiert den Namen und Pfad der RTF-Ausgabedatei.

 

string OutputRTF { set; }

HRESULT OutputRTF([in] BSTR bstrPath );

Property OutputRTF As String

 

 

Click to expand/collapseProductName

Ruft den Namen des Produkts ab: "StyleVision Server"

 

string ProductName { get; }

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

ReadOnly Property ProductName As String

 

 

Click to expand/collapseProductNameAndVersion

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

 

string ProductNameAndVersion { get; }

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

ReadOnly Property ProductNameAndVersion As String

 

 

Click to expand/collapseServerPath

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

 

string ServerPath { set; get; }

HRESULT ServerPath([in] BSTR bstrServerFile );

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

Property ServerPath As String

 

 

Click to expand/collapseServicePackVersion

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

 

int ServicePackVersion { get; }

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

ReadOnly Property ServicePackVersion As Integer

 

 

Click to expand/collapseWhereClause

Definiert eine SQL WHERE-Klausel, die festlegt, welche Zeilen einer DB-XML-Schemaquelle verarbeitet werden sollen.

 

string WhereClause { set; }

HRESULT WhereClause([in] BSTR bstrPath );

Property WhereClause As String

 

 

Click to expand/collapseWorkingDirectory

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

 

string WorkingDirectory { set; get; }

HRESULT WorkingDirectory([in] BSTR bstrWorkingDirectory );

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

Property WorkingDirectory As String

 

 

 


© 2019 Altova GmbH