IMAPISupport::Subscribe
Hace referencia a: Outlook 2013 | Outlook 2016
Registra un receptor de aviso para recibir notificaciones a través de MAPI.
HRESULT Subscribe(
LPNOTIFKEY lpKey,
ULONG ulEventMask,
ULONG ulFlags,
LPMAPIADVISESINK lpAdviseSink,
ULONG FAR * lpulConnection
);
Parameters
lpKey
[in] Puntero a una clave de notificación que representa el objeto de origen advise. El parámetro lpKey no puede ser NULL.
ulEventMask
[in] Máscara de valores que indican los tipos de eventos de notificación que el autor de la llamada está interesado y que debe incluirse en el registro. Los valores siguientes son válidos:
fnevCriticalError
Registra notificaciones sobre errores graves, como memoria insuficiente.
fnevExtended
Registra notificaciones sobre eventos específicos de la libreta de direcciones o del proveedor de almacén de mensajes determinados.
fnevNewMail
Se registra para recibir notificaciones sobre la llegada de nuevos mensajes.
fnevObjectCreated
Registra las notificaciones sobre la creación de un nuevo objeto.
fnevObjectCopied
Registra las notificaciones sobre un objeto que se va a copiar.
fnevObjectDeleted
Registra las notificaciones sobre un objeto que se va a eliminar.
fnevObjectModified
Registra las notificaciones sobre un objeto que se va a modificar.
fnevObjectMoved
Registra las notificaciones sobre un objeto que se va a mover.
fnevSearchComplete
Registra las notificaciones sobre la finalización de una operación de búsqueda.
ulFlags
[in] Máscara de bits de marcas que controla cómo se produce la notificación. Se puede establecer la marca siguiente:
NOTIFY_SYNC
Cuando el llamador llama al método IMAPISupport::Notify para generar notificaciones para este receptor de aviso, Notify debe realizar todas las llamadas necesarias para notificar a los receptores antes de devolver. Si no se establece esta marca, la notificación es asincrónica y las devoluciones de llamada se ponen en cola en los procesos que se han suscrito e iniciado cuando esos procesos obtienen el control de la CPU.
lpAdviseSink
[in] Puntero a un objeto receptor advise.
lpulConnection
[out] Puntero a un número de conexión distinto de cero que representa el registro.
Valor devuelto
S_OK
El registro de notificación se realizó correctamente.
Comentarios
El método IMAPISupport::Subscribe se implementa para todos los objetos de soporte técnico del proveedor de servicios. Los proveedores de servicios llaman a Subscribe desde uno de sus métodos Advise para permitir que MAPI administre las notificaciones.
Notas para los llamadores
Para usar los métodos de soporte técnico mapi para la notificación, cree una clave para el origen de avisos del objeto sobre qué notificaciones se deben generar. El valor de la clave debe ser único y debe regenerarse fácilmente cada vez que cambia el objeto.
MAPI usa la clave de notificación para buscar las funciones de devolución de llamada registradas a través de la función HrAllocAdviseSink para el origen de aviso correspondiente. Pase esta clave a IMAPISupport::Notify siempre que necesite generar una notificación para el origen de aviso correspondiente.
La marca NOTIFY_SYNC afecta al funcionamiento de las llamadas posteriores a Notify. Al establecer NOTIFY_SYNC, Notify no vuelve hasta que haya terminado de enviar todas las notificaciones necesarias. Cuando no establece NOTIFY_SYNC, Notify funciona de forma asincrónica, posiblemente devolviendo antes de que se hayan enviado todas las notificaciones.