substringData Method (Compact 2013)

3/26/2014

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

Syntax

strValue = oXMLDOMCharacterData.substringData(offset, count);

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

Parameters

Script

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

C/C++

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

Return Value

Script

String. Returns the substring.

C/C++

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

This method applies to the following objects and interfaces:

IXMLDOMCDATASection, IXMLDOMCharacterData, IXMLDOMComment, and IXMLDOMText.

Requirements

See Also

Reference

XML DOM Methods