Share via

substringData Method

  • Article

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

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

Script Syntax

            strValue = oXMLDOMCharacterData.substringData(offset, count);

Remarks

Script Parameters

  • offset
    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
    Long integer value indicating the number of characters to retrieve from the specified offset.

Script Return Value

String. Returns the substring.

C/C++ Syntax

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

Remarks

C/C++ 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, retval] Substring to return.

C/C++ Return Values

  • S_OK
    Value returned if successful.
  • S_FALSE
    Value when returning Null.

Requirements

Header msxml2.h, msxml2.idl
Library uuid.lib
Windows Embedded CE Windows CE .NET 4.0 and later

General 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.

This method applies to the following objects and interfaces:

IXMLDOMCDATASection, IXMLDOMCharacterData, IXMLDOMComment, and IXMLDOMText.