substringData Method

Script Syntax

strValue = oXMLDOMCharacterData.substringData(offset, count);

Parameters

offset

A long integer value indicating the offset, in characters, from the beginning of the string. An offset of zero indicates copying from the start of the data.

count

A long integer value indicating the number of characters to retrieve from the specified offset.

Return Value

A string. Returns the substring.

Example

The following script example creates an IXMLDOMComment object (comment), and then uses the substringData method to retrieve the first five characters of the object.

var xmlDoc = new ActiveXObject("Msxml2.DOMDocument.5.0");
var comment;
var MyStr;
xmlDoc.async = false;
xmlDoc.load("books.xml");
if (xmlDoc.parseError.errorCode <> 0) {
   var myErr = xmlDoc.parseError;
   alert("You have error " + myErr.reason);
} else {
   comment = xmlDoc.createComment("Hello World!");
   MyStr = comment.substringData(0, 5);
   alert(MyStr);
}

Visual Basic Syntax

strValue = oXMLDOMCharacterData.substringData(offset, count)

Parameters

offset

A long integer value indicating the offset, in characters, from the beginning of the string. An offset of zero indicates copying from the start of the data.

count

A long integer value indicating the number of characters to retrieve from the specified offset.

Return Value

A string. Returns the substring.

Example

The following Microsoft® Visual Basic® example creates an IXMLDOMComment object (comment), and then uses the substringData method to retrieve the first five characters of the object.

Dim xmlDoc As New Msxml2.DOMDocument50
Dim comment As IXMLDOMComment
Dim MyStr As String
xmlDoc.async = False
xmlDoc.Load ("books.xml")
If (xmlDoc.parseError.errorCode <> 0) Then
   Dim myErr
   Set myErr = xmlDoc.parseError
   MsgBox("You have error " & myErr.reason)
Else
   Set comment = xmlDoc.createComment("Hello World!")
   MyStr = comment.substringData(0, 5)
   MsgBox MyStr
End If

C/C++ Syntax

HRESULT substringData(
    long offset,
    long count,
    BSTR *data);

Parameters

offset [in]

The offset, in characters, from the beginning of the string. An offset of zero indicates copying from the start of the data.

count [in]

The number of characters to retrieve from the specified offset.

data [out, retval]

The substring to return.

C/C++ Return Values

S_OK

The value returned if successful.

S_FALSE

The value when returning Null.