Função PeerCollabEnumObjects (p2p.h)
A função PeerCollabEnumObjects retorna o identificador para uma enumeração que contém os objetos pares associados ao ponto de extremidade de um par específico.
Sintaxe
NOT_BUILD_WINDOWS_DEPRECATE HRESULT PeerCollabEnumObjects(
[in] PCPEER_ENDPOINT pcEndpoint,
[in, optional] const GUID *pObjectId,
[out] HPEERENUM *phPeerEnum
);
Parâmetros
[in] pcEndpoint
Ponteiro para uma estrutura PEER_ENDPOINT que contém as informações do ponto de extremidade de um par cujos objetos serão enumerados.
Se esse parâmetro for NULL , os objetos publicados dos contatos do par local serão retornados.
[in, optional] pObjectId
Ponteiro para um valor GUID que identifica exclusivamente um objeto par com o par fornecido. Se esse parâmetro for fornecido, o único objeto par retornado será aquele que corresponde a esse GUID.
[out] phPeerEnum
Ponteiro para o identificador do conjunto enumerado de objetos pares que correspondem ao GUID retornado em pObjectId. Passe esse identificador para PeerGetNextItem para obter cada item no conjunto enumerado.
Retornar valor
Retorna S_OK se a função for bem-sucedida. Caso contrário, a função retornará um dos valores a seguir.
| Código de retorno | Descrição |
|---|---|
|
Não há memória suficiente para dar suporte a essa operação. |
|
Um dos argumentos é inválido. |
|
A infraestrutura do Windows Peer não é inicializada. É necessário chamar a função de inicialização relevante. |
|
A operação exige que o usuário entre. |
Comentários
Objetos pares são itens de dados em tempo de execução associados a um aplicativo específico, como uma imagem, um avatar, um certificado ou uma descrição específica. Cada objeto par deve ter um tamanho menor que 16K.
PeerCollabEnumObjects retornará todos os objetos publicados para o par local. Os objetos podem ser publicados por mais de um aplicativo.
Para obter os objetos pares individuais, passe o identificador retornado para PeerGetNextItem. Os objetos par são retornados como uma matriz de ponteiros para as estruturas PEER_OBJECT . Se o ponto de extremidade não estiver publicando nenhum objeto, uma matriz vazia será retornada. Para fechar a enumeração e liberar os recursos associados a ela, passe esse identificador para PeerEndEnumeration. Itens individuais retornados pela enumeração devem ser lançados com PeerFreeData.
Para obter um objeto par com êxito:
- O ponto de extremidade deve ter sido obtido anteriormente chamando PeerCollabEnumEndpoints.
- O par local deve ter se inscrito no ponto de extremidade chamando PeerCollabSubscribeEndpointData.
- Os dados do ponto de extremidade devem ser atualizados chamando PeerCollabRefreshEndpointData com êxito.
Se o usuário estiver publicando uma imagem, a imagem poderá ser obtida recuperando o objeto correspondente. O GUID do objeto de imagem é PEER_COLLAB_OBJECTID_USER_PICTURE.
Requisitos
| Requisito | Valor |
|---|---|
| Cliente mínimo com suporte | Windows Vista [somente aplicativos da área de trabalho] |
| Servidor mínimo com suporte | Nenhum compatível |
| Plataforma de Destino | Windows |
| Cabeçalho | p2p.h |
| Biblioteca | P2P.lib |
| DLL | P2P.dll |