Método IEventControl::GetSubscriptions (eventsys.h)
Recupera a coleção de assinaturas associadas a um método de evento.
Sintaxe
HRESULT GetSubscriptions(
[in] BSTR methodName,
[in] BSTR optionalCriteria,
[in] int *optionalErrorIndex,
[out, retval] IEventObjectCollection **ppCollection
);
Parâmetros
[in] methodName
O método de evento associado à coleção de assinaturas.
[in] optionalCriteria
Os critérios de consulta. Se esse parâmetro for NULL, a consulta padrão especificada pelo método SetDefaultQuery será usada. Para obter detalhes sobre como formar uma expressão válida para esse parâmetro, consulte a seção Comentários abaixo.
[in] optionalErrorIndex
O local, expresso como um deslocamento, de um erro no parâmetro OptionalCriteria . Esse parâmetro não pode ser NULL.
[out, retval] ppCollection
Endereço de um ponteiro para a interface IEventObjectCollection em um objeto de coleção que enumera as assinaturas associadas ao objeto de evento.
Retornar valor
Se o método for bem-sucedido, ele retornará S_OK. Caso contrário, ele retornará um código de erro HRESULT.
Comentários
Esse método é uma forma mais especializada do método IEventSystem::Query . Além de obter apenas objetos de assinatura, uma coleção obtida chamando GetSubscriptions é atualizada automaticamente sempre que a coleção de assinatura é alterada.
Os critérios de consulta especificados pelo parâmetro optionalCriteria podem ser "ALL", para especificar uma solicitação para todos os objetos de assinatura ou uma expressão booliana que indica uma ou mais condições que um objeto de assinatura deve atender para ser incluída no resultado da consulta. As expressões válidas são da seguinte forma:
[NOT] propertynamerelationalOperatorvalue. Os operadores relacionais válidos são os seguintes:
==, =, !=, <>, ~=. Os valores válidos são "string", 'string', {GUID}, TRUE, FALSE, NULL.
Expressões boolianas individuais podem ser unidas com AND ou OR. As expressões podem ser aninhadas entre parênteses para impor uma ordem específica de avaliação.
A seguir estão alguns exemplos de critérios de consulta válidos:
"EventClassID == {F89859D1-6565-11D1-88C8-0080C7D771BF}"
"EventClassID == {F89859D1-6565-11D1-88C8-0080C7D771BF} AND MethodName = 'StockPriceChange'"
Requisitos
| Requisito | Valor |
|---|---|
| Cliente mínimo com suporte | Windows 2000 Professional [somente aplicativos da área de trabalho] |
| Servidor mínimo com suporte | Windows 2000 Server [somente aplicativos da área de trabalho] |
| Plataforma de Destino | Windows |
| Cabeçalho | eventsys.h |