Altova StyleVision Server 2023

Navigation: StyleVision Server API > API Reference

COM and .NET

The StyleVisionServer API exposes the IServer interface, which creates a new StyleVision Server object instance, and provides access to StyleVision Server.

The IServer interface has the following methods and properties.

Methods

AddParameter

Assigns a value to a parameter defined in the PXF file.

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

Clears the list of parameters.

void ClearParameterList()

C++

HRESULT ClearParameterList();

Sub ClearParameterList()

Generate

Generates one or more output files (HTML, PDF, RTF, and/or DOCX) by using the PXF file specified with TransfPath. It transforms the input XML file (Working XML File in the PXF file) using the XSLT document contained in the PXF file. Returns TRUE in case of success; FALSE otherwise.

bool Generate(string bstrTransfPath)

C++

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

Function Generate(ByVal bstrTransfPath As String) As Boolean

Properties

APIMajorVersion

Gets the major version of the StyleVision Server API. It can be different from the product version if the API is connected to another server.

int APIMajorVersion { get; }

C++

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

ReadOnly Property APIMajorVersion As Integer

APIMinorVersion

Gets the minor version of the StyleVision Server API. It can be different from the product version if the API is connected to another server.

int APIMinorVersion { get; }

C++

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

ReadOnly Property APIMinorVersion As Integer

APIServicePackVersion

Gets the service pack version of the StyleVision Server API. It can be different from the product version if the API is connected to another server.

int APIServicePackVersion { get; }

C++

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

ReadOnly Property APIServicePackVersion As Integer

InputXML

Sets the path and name of the XML file to be processed (the Working XML File in the PXF file).

string InputXML { set; }

C++

HRESULT InputXML([in] BSTR bstrPath );

Property InputXML As String

Is64Bit

Returns TRUE if the StyleVision Server engine is a 64-bit executable.

bool Is64Bit { get; }

C++

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

ReadOnly Property Is64Bit As Boolean

LastExecutionMessage

Gets the message received during the last Generate command.

string LastExecutionMessage { get; }

C++

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

ReadOnly Property LastExecutionMessage As String

MajorVersion

Gets the major version of StyleVision Server.

int MajorVersion { get; }

C++

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

ReadOnly Property MajorVersion As Integer

MinorVersion

Gets the minor version of StyleVision Server.

int MinorVersion { get; }

C++

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

ReadOnly Property MinorVersion As Integer

OutputDOCX

Sets the path and name of the output DOCX file.

string OutputDOCX { set; }

C++

HRESULT OutputDOCX([in] BSTR bstrPath );

Property OutputDOCX As String

OutputFO

Sets the path and name of the output FO file.

string OutputFO { set; }

C++

HRESULT OutputFO([in] BSTR bstrPath );

Property OutputFO As String

OutputHTML

Sets the path and name of the output HTML file.

string OutputHTML { set; }

C++

HRESULT OutputHTML([in] BSTR bstrPath );

Property OutputHTML As String

OutputPDF

Sets the path and name of the output PDF file.

string OutputPDF { set; }

C++

HRESULT OutputPDF([in] BSTR bstrPath );

Property OutputPDF As String

OutputRTF

Sets the path and name of the output RTF file.

string OutputRTF { set; }

C++

HRESULT OutputRTF([in] BSTR bstrPath );

Property OutputRTF As String

OutputText

Sets the path and name of the output Text file.

string OutputText { set; }

C++

HRESULT OutputText([in] BSTR bstrPath );

Property OutputText As String

ProductName

Gets the name of the product: "StyleVision Server"

string ProductName { get; }

C++

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

ReadOnly Property ProductName As String

ProductNameAndVersion

Gets the complete name of the product, including the version number: "StyleVision Server 2014r2 sp1 (x64)".

string ProductNameAndVersion { get; }

C++

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

ReadOnly Property ProductNameAndVersion As String

ServerPath

Gets or sets the path to the StyleVision Server executable.

string ServerPath { set; get; }

C++

HRESULT ServerPath([in] BSTR bstrServerFile );

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

Property ServerPath As String

ServicePackVersion

Gets the service pack version of StyleVision Server (for example: 1 for Altova StyleVision Server 2014 r2 sp1 (x64).)

int ServicePackVersion { get; }

C++

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

ReadOnly Property ServicePackVersion As Integer

WhereClause

Sets an SQL WHERE clause that determines the rows of a DB-XML schema source to process.

string WhereClause { set; }

C++

HRESULT WhereClause([in] BSTR bstrPath );

Property WhereClause As String

WorkingDirectory

Gets or sets the current directory for running jobs. Relative paths are evaluated against the working directory.

string WorkingDirectory { set; get; }

C++

HRESULT WorkingDirectory([in] BSTR bstrWorkingDirectory );

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

Property WorkingDirectory As String