iscEngineSetListener()

Finalidad

iscEngineSetListener() registra la función de escucha definida por el usuario con el motor de sincronización. Durante una sesión de sincronización, se llama a la función de escucha cuando se produce un suceso de sincronización (como, por ejemplo, el inicio de la sincronización) o un error.

Sintaxis

isy_INT32 iscEngineSetListener(
    HISCENG              hEngine,
    iscEngineListenerPF syncListener,
    isy_UINT32          syncListenerData);

Argumentos de la función

La Tabla 138 lista los argumentos válidos utilizados con la función iscEngineSetListener().

Tabla 138. Argumentos de iscEngineSetListener()

Tipo de datos Argumento Uso Descripción
HISCENG hEngine entrada Descriptor de contexto para el motor de sincronización
iscEngineListenerPF syncListener entrada Dirección de la función de escucha definida por el usuario
isy_UINT32 syncListenerData entrada Datos que la aplicación desea remitir a la función de escucha definida por el usuario

Uso

Registrando una función de escucha definida por el usuario, la aplicación tiene una vista en el proceso de sincronización. Se notifica a la aplicación cuando se producen sucesos o errores durante la sincronización. La aplicación puede personalizar métodos para presentar estos sucesos o errores a los usuarios.

Ejemplo:

// Se define la función syncListener con el prototipo siguiente:
isy_INT32 mySyncListener(
    isy_UINT32 listenerData,
    ISCEVT*     event,
    isy_VOID*   pExtraInfo);...
// El descriptor de contexto para el motor de sincronización se pasa
// a la función de escucha
iscEngineSetListener(hEngine, mySyncListener, (isy_UINT32) hEngine);        

Códigos de retorno

Restricciones

La función de escucha definida por el usuario debe seguir el protocolo del motor de sincronización o es posible que éste no funcione correctamente.

Conceptos relacionados

Tareas relacionadas

Consulta relacionada