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 结构定义自定义字段。

备注

此方法不会将变更保存到存储区中。必须通过调用 IReplicaMetadata::SaveItemMetadata 才能保存对 IItemMetadata 属性所做的全部变更。

请参阅

参考

IItemMetadata 接口