GetProperty (IXmlWriterLite)

 

Returns the specified property. An application can get properties at any time.

Syntax

  
HRESULT GetProperty ([in] UINT nProperty, [out] LONG_PTR ** ppValue);  

Arguments

nProperty
The enumeration that identifies the property to be retrieved. IXmlWriterLite uses the same properties as IXmlWriter. For more information, see IXmlWriter Properties.

ppValue
Returns the property value. This argument cannot be NULL. The type of the returned value depends on the nProperty specified.

Return Value

Returns S_OK if no error is generated. If an invalid property name is passed, returns E_NOTIMPL.

Remarks

Although most of the values referenced by the ppValue parameter are native or simple types, some are COM objects. For example, the XmlWriterProperty_MultiLanguage property references a COM IMultiLanguage2 instance. In these cases, release the pointer returned by a successful call to the GetProperty method by using the standard COM IUnknown::Release function.

Requirements

Header: XmlLite.h

Library: XmlLite.lib

See Also

IXmlWriterLite Methods
IXmlWriter Properties