Método IWSManSession::Enumerate (wsmandisp.h)
Enumera uma tabela, uma coleta de dados ou um recurso de log. Para criar uma consulta, inclua um parâmetro de filtro e um parâmetro de dialeto em uma enumeração. Você também pode usar um objeto IWSManResourceLocator para criar consultas. Para obter mais informações, consulte Enumerando ou listando todas as instâncias de um recurso.
Sintaxe
HRESULT Enumerate(
[in] VARIANT resourceUri,
[in, optional] BSTR filter,
[in, optional] BSTR dialect,
[in] long flags,
[out] IDispatch **resultSet
);
Parâmetros
[in] resourceUri
O identificador do recurso a ser recuperado.
A lista a seguir contém identificadores que esse parâmetro pode conter:
- URI com um ou mais seletores. Ao chamar o método Enumerate para obter um recurso WMI, use a propriedade key ou as propriedades do objeto .
- Você pode usar seletores, fragmentos ou opções. Para obter mais informações, consulte IWSManResourceLocator.
- Referência de ponto de extremidade de endereçamento WS, conforme descrito no padrão de protocolo WS-Management. Para obter mais informações sobre a especificação pública do protocolo WS-Management, consulte a página Índice de Especificações de Gerenciamento.
[in, optional] filter
Um filtro que define quais itens no recurso são retornados pela enumeração . Quando o recurso é enumerado, somente os itens que correspondem aos critérios de filtro são retornados. Incluir um parâmetro de filtro e um parâmetro dialeto em uma enumeração converte a enumeração em uma consulta.
Se você tiver um objeto IWSManResourceLocator para o parâmetro resourceURI , esse parâmetro não deverá ser usado. Em vez disso, use o seletor e a funcionalidade de fragmento do IWSManResourceLocator.
[in, optional] dialect
O idioma usado pelo filtro. O WQL, um subconjunto de SQL usado pelo WMI, é a única linguagem com suporte.
Se você tiver um objeto IWSManResourceLocator para o parâmetro resourceURI , esse parâmetro não deverá ser usado. Em vez disso, use o seletor e a funcionalidade de fragmento do IWSManResourceLocator.
[in] flags
Esse parâmetro deve conter um sinalizador na enumeração __WSManEnumFlags . Para obter mais informações, consulte Constantes de enumeração.
[out] resultSet
Um objeto IWSManEnumerator que contém os resultados da enumeração.
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
Chame IWSManSession::Enumerate para iniciar uma operação de enumeração. Depois disso, chame IWSManEnumerator::ReadItem usando o objeto IWSManEnumerator retornado até que o final dos itens seja indicado pela propriedade AtEndOfStream .
Lembre-se de que, se os sinalizadores incluírem as Constantes de EnumeraçãoWSManFlagHierarchyDeepBasePropsOnly ou WSManFlagHierarchyShallow , o serviço de Gerenciamento Remoto do Windows retornará o código de erro ERROR_WSMAN_POLYMORPHISM_MODE_UNSUPPORTED.
Para obter mais informações sobre como limitar chamadas de rede durante uma enumeração, consulte a propriedade BatchItems .
Se um filtro for especificado, ele deverá ser um documento válido em relação ao esquema do recurso. O parâmetro dialeto é opcional. No entanto, se a cadeia de caracteres de filtro começar com <, mas não for um fragmento XML, inclua o parâmetro dialeto ou defina o sinalizador WSManFlagNonXmlText no parâmetro flags . Para obter mais informações, consulte Constantes de enumeração.
O método de script correspondente é Session.Enumerate.
Requisitos
Requisito | Valor |
---|---|
Cliente mínimo com suporte | Windows Vista |
Servidor mínimo com suporte | Windows Server 2008 |
Plataforma de Destino | Windows |
Cabeçalho | wsmandisp.h |
Biblioteca | WSManDisp.tlb |
DLL | WSMAuto.dll |