Altova StyleVision Server 2023

Navigation: API de StyleVision Server > Referencia de la API

COM y .NET

La API de StyleVision Server expone la interfaz IServer, que crea una instancia de objeto StyleVision Server nueva y ofrece acceso a StyleVision Server.

La interfaz IServer tiene los métodos y propiedades que aparecen a continuación.

Métodos

AddParameter

Asigna un valor a un parámetro definido en el archivo 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

Borra la lista de parámetros.

void ClearParameterList()

C++

HRESULT ClearParameterList();

Sub ClearParameterList()

Generate

Genera archivos de salida (HTML, PDF, RTF o DOCX) con el archivo PXF indicado por TransfPath. Transforma el archivo XML de entrada (el archivo XML de trabajo del archivo PXF) con el documento XSLT que incluye el archivo PXF. Devuelve TRUE si la generación finaliza correctamente y FALSE si se produce un error.

bool Generate(string bstrTransfPath)

C++

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

Function Generate(ByVal bstrTransfPath As String) As Boolean

Propiedades

APIMajorVersion

Obtiene la versión principal de la API de StyleVision Server. Puede ser distinta a la versión del producto si la API está conectada a otro servidor.

int APIMajorVersion { get; }

C++

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

ReadOnly Property APIMajorVersion As Integer

APIMinorVersion

Obtiene la versión secundaria de la API de StyleVision Server. Puede ser distinta a la versión del producto si la API está conectada a otro servidor.

int APIMinorVersion { get; }

C++

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

ReadOnly Property APIMinorVersion As Integer

APIServicePackVersion

Obtiene la versión de service pack de la API de StyleVision Server. Puede ser distinta a la versión del producto si la API está conectada a otro servidor.

int APIServicePackVersion { get; }

C++

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

ReadOnly Property APIServicePackVersion As Integer

InputXML

Define la ruta de acceso y el nombre del archivo XML que se debe procesar (el archivo XML de trabajo del archivo PXF).

string InputXML { set; }

C++

HRESULT InputXML([in] BSTR bstrPath );

Property InputXML As String

Is64Bit

Devuelve TRUE si el motor de StyleVision Server es un ejecutable de 64 bits.

bool Is64Bit { get; }

C++

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

ReadOnly Property Is64Bit As Boolean

LastExecutionMessage

Obtiene el mensaje recibido durante la última ejecución del comando Generate.

string LastExecutionMessage { get; }

C++

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

ReadOnly Property LastExecutionMessage As String

MajorVersion

Obtiene la versión principal de StyleVision Server.

int MajorVersion { get; }

C++

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

ReadOnly Property MajorVersion As Integer

MinorVersion

Obtiene la versión secundaria de StyleVision Server.

int MinorVersion { get; }

C++

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

ReadOnly Property MinorVersion As Integer

OutputDOCX

Establece la ruta de acceso y el nombre del archivo DOCX de salida.

string OutputDOCX { set; }

C++

HRESULT OutputDOCX([in] BSTR bstrPath );

Property OutputDOCX As String

OutputFO

Establece la ruta de acceso y el nombre del archivo FO de salida.

string OutputFO { set; }

C++

HRESULT OutputFO([in] BSTR bstrPath );

Property OutputFO As String

OutputHTML

Establece la ruta de acceso y el nombre del archivo HTML de salida.

string OutputHTML { set; }

C++

HRESULT OutputHTML([in] BSTR bstrPath );

Property OutputHTML As String

OutputPDF

Establece la ruta de acceso y el nombre del archivo PDF de salida.

string OutputPDF { set; }

C++

HRESULT OutputPDF([in] BSTR bstrPath );

Property OutputPDF As String

OutputRTF

Establece la ruta de acceso y el nombre del archivo RTF de salida.

string OutputRTF { set; }

C++

HRESULT OutputRTF([in] BSTR bstrPath );

Property OutputRTF As String

OutputText

Establece la ruta de acceso y el nombre del archivo de texto de salida.

string OutputText { set; }

C++

HRESULT OutputText([in] BSTR bstrPath );

Property OutputText As String

ProductName

Obtiene el nombre del producto: "StyleVision Server"

string ProductName { get; }

C++

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

ReadOnly Property ProductName As String

ProductNameAndVersion

Obtiene el nombre completo del producto, incluido el número de versión: "StyleVision Server 2014r2 sp1 (x64)".

string ProductNameAndVersion { get; }

C++

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

ReadOnly Property ProductNameAndVersion As String

ServerPath

Obtiene o establece la ruta de acceso del ejecutable de StyleVision Server.

string ServerPath { set; get; }

C++

HRESULT ServerPath([in] BSTR bstrServerFile );

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

Property ServerPath As String

ServicePackVersion

Obtiene la versión de service pack de StyleVision Server (p. ej.: 1 si el nombre completo del producto es Altova StyleVision Server 2014 r2 sp1 (x64).)

int ServicePackVersion { get; }

C++

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

ReadOnly Property ServicePackVersion As Integer

WhereClause

Establece una cláusula WHERE de SQL que determina qué filas se deben procesar de la fuente de esquema XML de BD.

string WhereClause { set; }

C++

HRESULT WhereClause([in] BSTR bstrPath );

Property WhereClause As String

WorkingDirectory

Obtiene o establece el directorio actual para los trabajos en ejecución. Las rutas de acceso relativas se evalúan con respecto al directorio de trabajo.

string WorkingDirectory { set; get; }

C++

HRESULT WorkingDirectory([in] BSTR bstrWorkingDirectory );

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

Property WorkingDirectory As String