IServer

www.altova.com Imprimir este apartado Página anterior Subir un nivel Página siguiente

Inicio >  API de MapForce Server > Referencia de la API (.NET y COM) > Interfaces >

IServer

La interfaz IServer crea una instancia nueva del objeto MapForce Server y ofrece acceso al motor de MapForce Server.

 

Si está usando C++ en una plataforma COM, el nombre de la interfaz principal es IServer. Si está usando un lenguaje .NET, como C# o VB.NET, el nombre de la interfaz principal es Server.

 

Propiedades

Nombre

Descripción

APIMajorVersion

De solo lectura.

Obtiene la versión principal de la API de MapForce Server. Si la API está conectada a otro servidor, la versión puede diferir de la versión del producto.

APIMinorVersion

De solo lectura.

Obtiene la versión secundaria de la API de MapForce Server. Si la API está conectada a otro servidor, la versión puede diferir de la versión del producto.

APIServicePackVersion

De solo lectura.

Obtiene la versión de service pack de la API de MapForce Server. Si la API está conectada a otro servidor, la versión puede diferir de la versión del producto.

Is64Bit

De solo lectura.

Devuelve true si el motor de MapForce Server es un ejecutable de 64 bits.

LastExecutionMessage

De solo lectura.

Obtiene el mensaje obtenido durante la última ejecución del comando Run.

MajorVersion

De solo lectura.

Obtiene la versión principal del producto como número de años a partir de 1998 (p. ej. "20" para Altova MapForce Server 2018).

MinorVersion

De solo lectura.

Obtiene la versión secundaria del producto (p. ej. "2" para Altova MapForce Server 2018 r2).

ProductName

De solo lectura.

Obtiene la versión secundaria del producto (p. ej. "para Altova MapForce Server").

ProductNameAndVersion

De solo lectura.

Obtiene el nombre completo y la versión del producto (p. ej. "Altova MapForce Server 2018 r2 sp1 (x64)").

ServerPath

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

ServicePackVersion

De solo lectura.

Obtiene la versión de service pack del producto (p. ej. "1" para Altova MapForce Server 2018 r2 sp1).

WorkingDirectory

Obtiene o establece el directorio actual para los trabajos que están en ejecución (las rutas de acceso relativas se evaluarán en función del directorio de trabajo).

 

Métodos

Nombre

Descripción

AddParameter

Asigna un valor al parámetro definido en la asignación. El primer argumento especifica el nombre del parámetro tal y como se definió en la asignación. El segundo argumento especifica el valor del parámetro.

ClearOptions

Borra la lista de opciones previamente establecida con el método SetOption. Todas las opciones establecidas con el método SetOption son válidas para la vida útil del objeto. Llame a este método si necesita borrar de forma explícita todas las opciones previamente establecidas.

ClearParameterList

Borra la lista de parámetros que se definieron previamente con el método AddParameter.

GetOutputParameter

Obtiene la cadena de salida generada por el último comando run. Devuelve null si no se generó ningún resultado. Esta función requiere un parámetro de cadena que identifique el nombre que tiene el componente de salida en Altova MapForce.

Run

Ejecuta un archivo de ejecución de MapForce Server Execution (archivo .mfx). Devuelve true si se ejecuta correctamente. De lo contrario devuelve false.

SetOption

Establece una opción antes de ejecutar la asignación. El primer argumento especifica el nombre de la opción, mientras que el segundo argumento especifica el valor de la opción. Este método es especialmente útil para asignaciones diseñadas para que consuman recursos globales (véase Recursos globales de Altova). Estas son las opciones compatibles actualmente:

 

globalresourcefile (or gr): una ruta de acceso a los archivos de los recursos globales. (Si se indica esta opción también se debe indicar un nombre de configuración de los recursos globales, véase el siguiente punto).
globalresourcefile (or gr): un nombre de configuración de los recursos globales. (Si se indica esta opción también se debe indicar una ruta de acceso a los archivos de los recursos globales, véase el siguiente punto).
catalog: la ruta de acceso a un archivo RootCatalog.xml personalizado. Esta opción permite indicar un archivo de catálogo personalizado para resolver las URL que usa la asignación. El catálogo predeterminado está en el subdirectorio etc del directorio del programa de instalación.
taxonomy-package: la ruta a un paquete de taxonomías XBRL personalizado, si es necesario para la asignación.
taxonomy-packages-config-file: la ruta a un paquete de taxonomías XBRL personalizado, si es necesario para la asignación.

 

Todas las opciones establecidas son válidas para la vida útil del objeto. Si establece una opción dos veces con el mismo nombre se sobrescribirá la opción anterior. Para borrar de forma explícita todas las opciones, llame al método ClearOptions().

 

Ejemplos

En los siguientes ejemplos se muestra cómo inicializar y ejecutar MapForce Server en varios idiomas:

 

Ejemplo C++
Ejemplo C#
Ejemplo VBScript
Ejemplo VB.NET.

© 2019 Altova GmbH