IItemMetadata::TryGetFieldString

Devuelve el valor de un campo de cadena.

HRESULT TryGetFieldString(
  LPCWSTR pcszFieldName,
  LPWSTR pszValue,
  ULONG * pcchValue);

Parámetros

• pcszFieldName
  [in, string] Nombre del campo.

• pszValue
  [in, out, size_is(*pcchValue)] Devuelve el valor del campo especificado.

• pcchValue
  [in, out] Especifica el número de caracteres de pszValue. Devuelve el número de caracteres necesario para recuperar el valor de campo especificado cuando pszValue es demasiado pequeño; en caso contrario, devuelve el número de caracteres escritos, incluido el terminador nulo.

Valor devuelto

• S_OK.

• S_FALSE si el valor no se ha establecido o se ha establecido en NULL.

• E_POINTER.

• E_INVALIDARG.

• SYNC_E_METADATA_FIELD_INVALID_NAME si el campo no existe.

• SYNC_E_METADATA_FIELD_INVALID_TYPE si el campo no es una cadena.

• HRESULT_FROM_WIN32(ERROR_MORE_DATA) si pszValue no es suficientemente grande para recibir el valor del campo. En esta situación, pcchValue devuelve el número necesario de caracteres.

Notas

Los campos personalizados se deben definir mediante una estructura CUSTOM_FIELD_DEFINITION cuando se inicializan por primera vez los metadatos de réplica.

Si se llamó a IItemMetadata::SetFieldString para establecer el valor del campo, pero el cambio no se ha guardado aún mediante una llamada a IReplicaMetadata::SaveItemMetadata, TryGetFieldString devuelve el valor incluido en el objeto IItemMetadata y no el valor almacenado en el almacén de metadatos.

Vea también

Referencia

Interfaz IItemMetadata