Microsoft XML 2.5 SDK


 

IXTLRuntime::formatIndex Method

[This is preliminary documentation and subject to change.]

Formats the supplied integer using the specified numerical system.

Visual Basic Syntax

strValue = oXTLRuntime.formatIndex(lIndex, bstrFormat)

C/C++ 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.

C/C++ Return Value

Returns S_OK if successful, or an error code otherwise.