Edit

Share via

IReplicaKeyMap::LookupReplicaId method (winsync.h)

  • Article

Gets the replica ID that corresponds to the specified replica key.

Syntax

HRESULT LookupReplicaId(
  [in]      DWORD dwReplicaKey,
  [in, out] BYTE  *pbReplicaId,
  [in, out] DWORD *pcbIdSize
);

Parameters

[in] dwReplicaKey

The replica key to look up.

[in, out] pbReplicaId

Returns the replica ID that corresponds to dwReplicaKey.

[in, out] pcbIdSize

Specifies the number of bytes in pbReplicaId. Returns the number of bytes required to retrieve the ID when pbReplicaId is too small, or returns the number of bytes written.

Return value

The possible return codes include, but are not limited to, the values shown in the following table.

Return code Description
S_OK
 The method succeeded.
E_POINTER
 Invalid pointer.
SYNC_E_REPLICA_NOT_FOUND
 dwReplicaKey is not found.
HRESULT_FROM_WIN32(ERROR_MORE_DATA)
 pbReplicaId is too small. In this case, the required number of bytes is returned in pcbIdSize.

Requirements

Requirement Value
Minimum supported client Windows 7 [desktop apps only]
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Target Platform Windows
Header winsync.h

See also

IReplicaKeyMap Interface