Edit

Share via

PeerGroupDeleteRecord function (p2p.h)

  • Article

The PeerGroupDeleteRecord function deletes a record from a peer group. The creator, as well as any other member in an administrative role may delete a specific record.

Syntax

NOT_BUILD_WINDOWS_DEPRECATE HRESULT PeerGroupDeleteRecord(
  [in] HGROUP     hGroup,
  [in] const GUID *pRecordId
);

Parameters

[in] hGroup

Handle to the peer group that contains the record. This handle is returned by the PeerGroupCreate, PeerGroupOpen, or PeerGroupJoin function. This parameter is required.

[in] pRecordId

Specifies the GUID value that uniquely identifies the record to be deleted. 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
PEER_E_GROUP_NOT_READY
 The peer group is not in a state where records can be deleted. For example, PeerGroupJoin is called, but synchronization with the peer group database has not completed.
PEER_E_INVALID_GROUP
 The handle to the peer group is invalid.
PEER_E_NOT_AUTHORIZED
 The current identity does not have the authorization to delete the record. In this case, the identity is not the creator or a member in an administrative role may delete a specific record.
PEER_E_RECORD_NOT_FOUND
 The record cannot be located in the data store.
 

Cryptography-specific errors can be returned from the Microsoft RSA Base Provider. These errors are prefixed with CRYPT_* and defined in Winerror.h.

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

See also

PeerGroupAddRecord

PeerGroupCreate

PeerGroupJoin

PeerGroupOpen

PeerGroupUpdateRecord