IReplicaMetadata::GetCustomFieldMetadata

  • Article

Gets the custom metadata field that is associated with this replica.

Syntax

HRESULT GetCustomFieldMetadata(
  BYTE * pbValue,
  ULONG * pcbValue);

Parameters

  • pbValue
    [in, out, unique, size_is(*pcbValue)] Returns the custom metadata field value.

  • pcbValue
    [in, out] Specifies the number of bytes in pbValue. Returns the required number of bytes for pbValue when pbValue is too small, or the number of bytes written to pbValue when data is written.

Return Value

  • S_OK.

  • E_POINTER.

  • HRESULT_FROM_WIN32(ERROR_MORE_DATA) when pbValue is too small. In this case, pcbValue returns the number of bytes required.

  • SYNC_E_METADATA_VALUE_NOT_SET if the custom metadata field value has not been set or if it was set to NULL.

Remarks

The custom metadata field provides a place to store information about the replica as a whole.

See Also

Reference

IReplicaMetadata Interface