IXTLRuntime::formatIndex Method

Formats the supplied integer using the specified numerical system.

Syntax

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

Parameters

lIndex

[in] Integer value that is to be converted.

bstrFormat

[in] Numbering system. The following codes are supported:

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", ...

pbstrFormattedString

[out] Integer value formatted using the specified numbering system.

Return Value

Returns S_OK if successful, or an error code otherwise.