API unificada de NCH Software

Una completa solución API para los productos de NCH Software

Nuestro software puede ser controlado por otros programas usando una variedad de métodos escritos en muchos lenguajes diferentes. La Interfaz de Programación de Aplicaciones (API) unificada de NCH introduce una manera simple de abordar la necesidad en sus sistemas para controlar nuestros programas. La API permite el intercambio de solicitudes y datos que se realizan entre los programas a través de diversos medios.

Los diferentes métodos (con ejemplos de "fragmento de código") para el uso de la API unificada incluyen:

• Biblioteca de enlaces dinámicos (DLL) - C y C++
• Modelo de objetos componentes (COM) - VB y VBS
  • ActiveX
• Interfaz de línea de comando (CLI)
• Java Native Interface (JNI) - Java
• Microsoft .NET Framework - C# - VB.NET

En los ejemplos a continuación, "NCHAPIKey" se refiere a un código API Key único que identifica el producto de software al que está intentando controlar y comunicarse. Todos los comandos y argumentos son enviados a través de la API unificada como cadenas, las cuales responden con un número (valor entero devuelto) y una cadena de resultado. Para más información sobre códigos API Key y los comandos y argumentos disponibles por ese programa en particular, visite la página principal del producto y consulte la documentación API específica para esa aplicación. Para encontrar la lista completa de nuestros productos de software presione aquí...

  Volver al principio

Biblioteca de enlaces dinámicos (DLL)

#define API_SERVER_KEY "NCHAPIKey"

const unsigned int nArgs = 3;
LPCTSTR szArgs[] = {_T("-testapi"), _T("More Info"), _T("etc...")};

typedef DWORD (WINAPI *pFn) (LPCTSTR szProgramKey, UINT nArgs, LPCTSTR  const * szArgs, LPTSTR szResultString);

void SendCommandDLL()
{
  HMODULE hModDll = LoadLibrary(_T("nchapi.dll"));
  pFn pfSendCommand = (pFn)GetProcAddress(hModDll, "NCHAPISendCommand");

  TCHAR szResultString[8096]; 
  if ((pfSendCommand)(_T(API_SERVER_KEY), nArgs, szArgs, szResultString) == 0) {
    MessageBox(NULL, szResultString, _T("Result"), MB_OK);
  }
  FreeLibrary(hModDll);
}

  Volver al principio

Modelo de objetos componentes (COM) / ActiveX

En una máquina con Windows para registrar el archivo nchapi.dll debe escribir en la ventana de ejecución (Inicio -> Ejecutar) algo como:

regsvr32 "nchapi.dll"

A continuación, un ejemplo VB y VBS que usa COM para enviar un comando, que devuelve un resultado en un cuadro emergente:

Dim shell, client, result
set shell = CreateObject("WScript.Shell")
set client = CreateObject("NCHAPI.Client")

Dim ServerKey
ServerKey = "NCHAPIKey"
Dim nArgs
nArgs = 3
Dim szArgs
szArgs = Array("-testapi", "More Info", "etc...")
Dim szResultString

if client.SendCommand(ServerKey, CInt(nArgs), szArgs, szResultString) = 0 then
  result = shell.Popup(szResultString, 0, "Result")
end if

  Volver al principio

Interfaz de línea de comando (CLI)

La sintaxis general es:

nchapi.exe NCHAPIKey -testapi "More Info" "etc..."

  Volver al principio

Java Native Interface (JNI)

El primer ejemplo usa simplemente la clase NCHAPIClient proporcionada como la interfaz a través de la cual la API unificada de NCH es llamada:

import nch.api.NCHAPIClient;

public void sendCommandJNI() {
  String serverKey = "NCHAPIKey";
  String[] szArgs = { "-testapi", "More Info", "etc..." };
  NCHAPIClient client = new NCHAPIClient();
  if (client.sendCommand(serverKey, szArgs) == client.NCHAPI_SUCCESS) {
     JOptionPane.showMessageDialog(null, client.getResultString(), "Result", JOptionPane.INFORMATION_MESSAGE);
  }
}

package nch.api;
private static native int NCHAPISendCommand(String szServerKey, int nArgs, String[] szArgs, String[] szResultString);

public class NCHAPIClient {

public NCHAPIClient() {
  System.loadLibrary("nchapi");

  private String serverKey = "NCHAPIKey;
  private int nArgs = 3;
  private String[] szArgs = { "-testapi", "More Info", "etc..." };
  private String[] szReturnString = null;
  
  if (NCHAPISendCommand(serverKey, nArgs, szArgs, szReturnString) == 0) {
    JOptionPane.showMessageDialog(null, szReturnString, "Result", JOptionPane.INFORMATION_MESSAGE);
  }
}
}

  Volver al principio

Microsoft .NET Framework

A continuación, un ejemplo de C# usando NET que devuelve un resultado a un cuadro de mensaje:

public partial class FormMainDialog : Form
{
  NCHApi.Client apiCOMClient;
  public FormMainDialog()
  {
    InitializeComponent();
    apiCOMClient = new NCHApi.Client();
  }
  private void buttonSendCommand_Click(object sender, EventArgs e)
  {
    string ServerKey = "NCHAPIKey";
    int nArgs = 3;
    string[] szArgs = {"-testapi", "More Info", "etc..."};
    string szResultString = "";

    if (NCHApi.NCHAPIResult.Success == apiCOMClient.SendCommand(ServerKey, nArgs, szArgs, ref szResultString))
    {
      MessageBox.Show(szResultString, "Result", MessageBoxButtons.OK, MessageBoxIcon.Information);
    }
  }
}

Public Class MainForm
  Private Sub buttonSendCommand_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles buttonSendCommand.Click
    Dim comClient As New NCHApi.Client()

    Dim ServerKey As String = "NCHAPIKey"
    Dim nArgs As Integer = 3
    Dim szArgs As String() = New String() {"-testapi", "More Info", "etc..."}
    Dim szResultString As String = ""

    Dim res As NCHApi.NCHAPIResult
      res = comClient.SendCommand(ServerKey, nArgs, szArgs, szResultString)
    If (res = NCHApi.NCHAPIResult.Success) Then
      MsgBox(szResultString, MsgBoxStyle.OkOnly & MsgBoxStyle.Information, "Result")
    End If
  End Sub
End Class

  Volver al principio

Posibilidades ilimitadas

Imagine que está fuera de casa y olvidó grabar su programa de radio favorito por la web o se olvidó de ejecutar VRS para grabar las llamadas telefónicas. Simplemente marque al sistema IVM y use el indicador para enviar comandos a través de la API unificada a los programas respectivos para que empiecen a grabar.

¿Qué sucede si desea configurar una extensión en Axon para un tiempo específico? Simplemente use el programador de Windows y la API unificada para enviar un comando a Axon informando para que configure la extensión apropiada. ¿Necesita marcar un número automáticamente pero siempre está fuera de casa? Otra vez, use el programador de Windows y la API unificada para instruir IVM o Express Talk para que realicen la llamada.

  Volver al principio

Otra información

  Volver al principio