Microsoft XML 2.5 SDK


 

IXMLDOMCharacterData::substringData Method

[This is preliminary documentation and subject to change.]

Retrieves a substring of the full string from the specified range.

Visual Basic Syntax

strValue = oXMLDOMCharacterData.substringData(offset, count)

C/C++ Syntax

HRESULT substringData(

    long offset,

    long count,

    BSTR *data);

Parameters

offset

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

count

[in]
Number of characters to retrieve from the specified offset.

data

[out]
Substring to return.

C/C++ Return Values

S_OK

Value returned if successful.

S_FALSE

Value when returning null.

Remarks

If the offset and count parameters indicate a range beyond the end of the string, the returned substring continues only until the end of the string data.