Share via

IItemMetadata::TryGetFieldUInt8

  • Article

Gets the value of an 8-bit unsigned integer field.

HRESULT TryGetFieldUInt8(
  LPCWSTR pcszFieldName,
  BYTE * pbValue);

Parameters

  • pcszFieldName
    [in, string] The name of the field.
  • pbValue
    [out] Returns the value of the specified field.

Return Value

  • S_OK

  • S_FALSE if the value has not been set.

  • E_POINTER

  • E_INVALIDARG

  • SYNC_E_METADATA_FIELD_INVALID_NAME if the field does not exist.

  • SYNC_E_METADATA_FIELD_INVALID_TYPE if the field is not an 8-bit unsigned integer.

Remarks

Custom fields must be defined by using a CUSTOM_FIELD_DEFINITION structure when the replica metadata is first initialized.

If IItemMetadata::SetFieldUInt8 was called to set the field value, but the change has not yet been saved by a call to IReplicaMetadata::SaveItemMetadata, TryGetFieldUInt8 returns the value that is contained in the IItemMetadata object and not the value that is stored in the metadata store.

See Also

Reference

IItemMetadata Interface