putProperty Method

MSXML 5.0 SDK

previous page next page
Microsoft XML Core Services (MSXML) 5.0 for Microsoft Office - SAX2 Reference

putProperty Method

Sets the value of a property. The property name is any qualified Uniform Resource Identifier (URI).

[Visual Basic]

Usage Syntax

oSAXXMLReader.putProperty(strName, varValue)

Parameters

strName
The property's name.
varValue
The corresponding data type of the property.

Return Values

The following table shows the return values for the putProperty method.

Property Returns
charset schema-declaration-handler Sets property
declaration-handler
lexical-handler
schemas		 Trappable error (if unable to set property).
dom-node
xmldecl-encoding
xmldecl-version
xmldecl-standalone
xml-string		 Trappable error.
Other properties Trappable error

[C/C++]

Although a core set of properties is defined, a reader is not required to recognize any specific property names. Some property values may be available only in a specific context, such as before, during, or after a parse.

Syntax

HRESULT putProperty(
   [in] const wchar_t * pwchName,
 [in] VARIANT varValue);

Parameters

pwchName [in]
The property's name (zero-terminated Unicode string).
varValue [in]
The corresponding data type of the property.

Return Values

The following table lists the return values for the putProperty method.

Property Returns
charset
schema-declaration-handler		 S_OK (regardless of parsing mode)
declaration-handler
lexical-handler
schemas		 S_OK (not parsing)

E_FAIL (parsing)
dom-node
xmldecl-encoding
xmldecl-version
xmldecl-standalone
xml-string		 E_FAIL
Other properties E_INVALIDARG

Remarks

The ISAXXMLReader interface recognizes the following properties:

"http://xml.org/sax/properties/lexical-handler"
This is an optional extension handler for lexical events, like comments.
Datatype — ISAXXMLLexicalHandler.
Access — Read/write.
"http://xml.org/sax/properties/declaration-handler"
This is an optional extension handler for declaration events.
Datatype — ISAXXMLDeclHandler
Access — Read/write.
"charset"
Externally defined encoding to use with an XML document. An example is the one used in the MIME-header. This setting takes priority over the default encoding, which is implicitly UTF-16, or over the encoding specified in the byte order mark (BOM) of the XML document header.
This property only affects documents that are parsed using the parse method. For any documents that are parsed using the parseURL method, this property is ignored. This property can be set at any time, but it only affects documents that are opened after it is set. For example, if it is set in the resolveEntity method (which is available when you implement a SAX entity resolver), it affects the external entity to be opened, but does not affect the main document, which is currently being parsed.
Datatype — BSTR* (The string value must be a recognized description of a character set that is valid for use with XML. For example, "US-ASCII", "UTF-8", etc.)
Default — Empty (uses either the BOM in XML header or the default encoding)
Access — Read/write.
"http://xml.org/sax/properties/dom-node"
Source DOM node for current SAX event. Only available when using parse method and SAX events are generated from an IXMLDOMNode object. Not available when using parseURL method for SAX parsing of a file.
Datatype — IXMLDOMNode.
Access — Read-only.
"http://xml.org/sax/properties/xml-string"
The literal string of characters in the XML source for the current SAX event.
Datatype — String (Visual Basic) / w_chart* (C/C++)
Access — Read-only.
"schemas"
An option for registering a schema with the SAX reader.
Datatype — XMLSchemaCache.
Access — (parsing) Read-only; (not parsing) Read/Write.
"schema-declaration-handler"
An option for registering a schema-based declaration handler with the SAX reader.
Datatype — Event handler that implements the IMXSchemaDeclHandler interface.
Access — Read/write.
"xmldecl-encoding"
Encoding declared in the XML header of the currently parsed document. This data is unavailable until the reader parses the XML header.
Datatype — BSTR.
Default — Empty (if there is no XML declaration or a property is not found).
Access — (parsing) Read; (not parsing) None.
"xmldecl-version"
Version declared in the XML header of currently parsed document. This data is unavailable until the reader parses the XML header.
Datatype — BSTR.
Default — Empty (if there is no XML declaration).
Access — (parsing) Read; (not parsing) None.
"xmldecl-standalone"
Declared in the XML header of currently parsed document. This data is unavailable until the reader parses the XML header.
Datatype — BSTR ("yes" or "no").
Default — Empty (if there is no XML declaration or if a property is not found).
Access — (parsing) Read; (not parsing) None.
Note   The "xmldecl-encoding", "xmldecl-version", and "xmldecl-standalone" properties provide information about the presence and content of the XML header. However, XML header information was designed for low-level reader and parser use, not for applications.

To view reference information for Visual Basic or C/C++ only, click the Language Filter button Language Filter in the upper-left corner of the page.

See Also

getProperty Method

Applies to: ISAXXMLReader Interface

previous page start next page