IItemMetadata::SetFieldString

文字列フィールドの値を設定します。

HRESULT SetFieldString(
  LPCWSTR pcszFieldName,
  LPCWSTR pcszValue);

パラメーター

  • pcszFieldName
    [in, string] フィールドの名前。
  • pcszValue
    [in, unique] フィールドの値。

戻り値

  • S_OK

  • E_POINTER

  • E_INVALIDARG

  • フィールドが存在しない場合は SYNC_E_METADATA_FIELD_INVALID_NAME。

  • カスタム フィールド スキーマでフィールドが文字列型でない場合は SYNC_E_METADATA_FIELD_INVALID_TYPE。

解説

pcszValue に NULL を指定すると、フィールド値を空にリセットできます。

カスタム フィールドは、レプリカ メタデータを初めて初期化するときに、CUSTOM_FIELD_DEFINITION 構造体を使用して定義する必要があります。

注意

このメソッドでは変更がストアに保存されません。IItemMetadata プロパティに加えたすべての変更を保存するには、IReplicaMetadata::SaveItemMetadata を呼び出す必要があります。

参照

リファレンス

IItemMetadata インターフェイス