Share via

formatIndex Method

  • Article

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

Formats the index integer using the specified numerical system.

Script Syntax

            strValue = oXTLRuntime.formatIndex(lIndex, bstrFormat);

Remarks

Script Parameters

  • lIndex
    Long integer. Integer value that is to be converted.
  • bstrFormat
    String. Specified numbering system. See Remarks.

Script Return Value

String. Returns the integer value formatted using the specified numbering system.

C/C++ Syntax

HRESULT formatIndex(
  long lIndex,
  BSTR bstrFormat,
  BSTR* pbstrFormattedString
);

Remarks

C/C++ Parameters

  • lIndex
    [in] Integer value that is to be converted.
  • bstrFormat
    [in] Numbering system. See Remarks section.
  • pbstrFormattedString
    [out, retval] Integer value formatted using the specified numbering system.

C/C++ Return Values

  • S_OK
    Value returned if successful.

Requirements

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

General Remarks

The following table shows the formats supported by the specified numerical system.

Number format Meaning

1

Standard numbering system

01

Standard numbering with leading zeroes

A

Uppercase sequence: A–Z, AA–ZZ

a

Lowercase sequence: a–z, aa–zz

I

Uppercase Roman numerals: I, II, III, IV, ...

I

Lowercase Roman numerals: i, ii, iii, iv, ...

This method applies to the following interface:

IXTLRuntime.