PeerGroupGetProperties function (p2p.h)
The PeerGroupGetProperties function retrieves information on the properties of a specified group.
Syntax
NOT_BUILD_WINDOWS_DEPRECATE HRESULT PeerGroupGetProperties(
[in] HGROUP hGroup,
[out] PPEER_GROUP_PROPERTIES *ppProperties
);
Parameters
[in] hGroup
Handle to a peer group whose properties are retrieved. This handle is returned by the PeerGroupCreate, PeerGroupOpen, or PeerGroupJoin function. This parameter is required.
[out] ppProperties
Pointer to a PEER_GROUP_PROPERTIES structure that contains information about peer group properties. This data must be freed with PeerFreeData. This parameter is required.
Return value
Returns S_OK if the operation succeeds. Otherwise, the function returns one of the following values.
| Return code | Description |
|---|---|
|
One of the parameters is not valid. |
|
There is not enough memory to perform a specified operation. |
|
The group is not in a state where peer group properties can be retrieved. For example, PeerGroupJoin is called, but synchronization with the group database has not completed. |
|
The handle to the peer group is invalid. |
Cryptography-specific errors can be returned from the Microsoft RSA Base Provider. These errors are prefixed with CRYPT_* and defined in Winerror.h.
Remarks
Group properties cannot be retrieved if a peer has not synchronized with a peer group database. To synchronize with a peer group database before calling this function, first call PeerGroupConnect.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows XP with SP2 [desktop apps only],Windows XP with SP1 with the Advanced Networking Pack forWindows XP |
| Minimum supported server | None supported |
| Target Platform | Windows |
| Header | p2p.h |
| Library | P2P.lib |
| DLL | P2P.dll |