IMetaDataImport::GetFieldProps method

Gets metadata associated with the field referenced by the specified FieldDef token.

Syntax

HRESULT GetFieldProps(
  [in]                                           mdFieldDef      tkFieldDef,
  [out]                                          mdTypeDef       *ptkTypeDef,
  [out, size_is(cchField), length_is(*pchField)] LPWSTR          szField,
  [in]                                           ULONG           cchField,
  [out]                                          ULONG           *pchField,
  [out]                                          DWORD           *pdwAttr,
  [out, size_is(, *pcbSigBlob)]                  PCCOR_SIGNATURE *ppvSigBlob,
  [out]                                          ULONG           *pcbSigBlob,
  [out]                                          DWORD           *pdwCPlusTypeFlag,
  [out, size_is(, *pcchValue)]                   UVCP_CONSTANT   *ppValue,
  [out]                                          ULONG           *pcchValue
);

Parameters

tkFieldDef [in]

A FieldDef token that represents the field to get associated metadata for.

ptkTypeDef [out]

A pointer to a TypeDef token that represents the type of the class that the field belongs to.

szField [out]

The name of the field.

cchField [in]

The size in wide characters of the buffer for szField.

pchField [out]

The actual size of the returned buffer.

pdwAttr [out]

Flags associated with the field's metadata.

ppvSigBlob [out]

A pointer to the binary metadata value that describes the field.

pcbSigBlob [out]

The size in bytes of ppvSigBlob.

pdwCPlusTypeFlag [out]

A flag that specifies the value type of the field.

ppValue [out]

A constant value for the field.

pcchValue [out]

The size in chars of ppValue, or zero if no string exists.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

See also

IMetaDataImport