EncodeName

Applies to: SharePoint Foundation 2010

Encodes the property name according to XML encoding conventions for XML identifiers.

HRESULT EncodeName(
   LPCSTR sz,
   LPSTR szOut,
   int *pcchOut
);

Parameters

sz

[in] The property name to encode.

szOut

[out] The field name that corresponds to the property name.

pcchOut

[in,out]

Return Value

The IParserPropertyBag methods return typical HRESULT values. In general, the method should return a positive OK value when successful or a negative FAIL value when unsuccessful.

Remarks

This method uses the list schema that is returned by the GetSchemaXml method to map the name of a property in the property bag to the name of a field on the list.

Output from the EncodeName method encodes non-alphanumeric characters, such as spaces, in Unicode Transformation Format (UTF). For example, the string "two words" is encoded as "two_x0020_words".

See Also

Reference

IParserPropertyBag Interface

GetSchemaXml

DecodeName

Concepts

Custom Document Parsers

Document Parser Interface Overview