IFieldValue::GetStringValue

Gets the value of a field of type SYNC_METADATA_FIELD_TYPE_STRING.


HRESULT GetStringValue(
  LPWSTR pszValue,
  ULONG * pcchValue);

pszValue

[in, out, unique, size_is(*pcchValue)] Returns the field value.

pcchValue

[in, out] Specifies the number of characters in pszValue. Returns the number of characters required to retrieve the ID when pszValue is too small, or returns the number of characters written.

  • S_OK.

  • S_FALSE if the value has not been set.

  • E_POINTER.

  • SYNC_E_METADATA_FIELD_INVALID_TYPE when the field is not of type SYNC_METADATA_FIELD_TYPE_STRING.

  • HRESULT_FROM_WIN32(ERROR_MORE_DATA) when pszValue is too small. In this situation, the required number of characters is returned in pcchValue.

Show: