COM y .NET

www.altova.com Expandir/Contraer todos Imprimir este apartado Página anterior Subir un nivel Página siguiente

Inicio >  Altova StyleVision Server 2019 > 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

 

Haga clic para expandir/contraerAddParameter

Asigna un valor a un parámetro definido en el archivo PXF.

 

void AddParameter(string bstrName, string bstrValue)

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

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

 

 

Haga clic para expandir/contraerClearParameterList

Borra la lista de parámetros.

 

void ClearParameterList()

HRESULT ClearParameterList();

Sub ClearParameterList()

 

 

Haga clic para expandir/contraerGenerate

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)

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

Function Generate(ByVal bstrTransfPath As String) As Boolean

 

 

 

 

Propiedades

 

Haga clic para expandir/contraerAPIMajorVersion

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; }

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

ReadOnly Property APIMajorVersion As Integer

 

 

Haga clic para expandir/contraerAPIMinorVersion

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; }

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

ReadOnly Property APIMinorVersion As Integer

 

 

Haga clic para expandir/contraerAPIServicePackVersion

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; }

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

ReadOnly Property APIServicePackVersion As Integer

 

 

Haga clic para expandir/contraerInputXML

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; }

HRESULT InputXML([in] BSTR bstrPath );

Property InputXML As String

 

 

Haga clic para expandir/contraerIs64Bit

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

 

bool Is64Bit { get; }

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

ReadOnly Property Is64Bit As Boolean

 

 

Haga clic para expandir/contraerLastExecutionMessage

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

 

string LastExecutionMessage { get; }

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

ReadOnly Property LastExecutionMessage As String

 

 

Haga clic para expandir/contraerMajorVersion

Obtiene la versión principal de StyleVision Server.

 

int MajorVersion { get; }

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

ReadOnly Property MajorVersion As Integer

 

 

Haga clic para expandir/contraerMinorVersion

Obtiene la versión secundaria de StyleVision Server.

 

int MinorVersion { get; }

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

ReadOnly Property MinorVersion As Integer

 

 

Haga clic para expandir/contraerOutputDOCX

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

 

string OutputDOCX { set; }

HRESULT OutputDOCX([in] BSTR bstrPath );

Property OutputDOCX As String

 

 

Clic para expandir/contraerOutputFO

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

 

string OutputFO { set; }

HRESULT OutputFO([in] BSTR bstrPath );

Property OutputFO As String

 

 

Haga clic para expandir/contraerOutputHTML

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

 

string OutputHTML { set; }

HRESULT OutputHTML([in] BSTR bstrPath );

Property OutputHTML As String

 

 

Haga clic para expandir/contraerOutputPDF

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

 

string OutputPDF { set; }

HRESULT OutputPDF([in] BSTR bstrPath );

Property OutputPDF As String

 

 

Haga clic para expandir/contraerOutputRTF

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

 

string OutputRTF { set; }

HRESULT OutputRTF([in] BSTR bstrPath );

Property OutputRTF As String

 

 

Haga clic para expandir/contraerProductName

Obtiene el nombre del producto: "StyleVision Server"

 

string ProductName { get; }

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

ReadOnly Property ProductName As String

 

 

Haga clic para expandir/contraerProductNameAndVersion

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

 

string ProductNameAndVersion { get; }

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

ReadOnly Property ProductNameAndVersion As String

 

 

Haga clic para expandir/contraerServerPath

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

 

string ServerPath { set; get; }

HRESULT ServerPath([in] BSTR bstrServerFile );

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

Property ServerPath As String

 

 

Haga clic para expandir/contraerServicePackVersion

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; }

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

ReadOnly Property ServicePackVersion As Integer

 

 

Clic para expandir/contraerWhereClause

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; }

HRESULT WhereClause([in] BSTR bstrPath );

Property WhereClause As String

 

 

Haga clic para expandir/contraerWorkingDirectory

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; }

HRESULT WorkingDirectory([in] BSTR bstrWorkingDirectory );

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

Property WorkingDirectory As String

 

 


© 2019 Altova GmbH