formatIndex Method (Compact 2013)
3/26/2014
Formats the index integer using the specified numerical system.
Syntax
strValue = oXTLRuntime.formatIndex(lIndex, bstrFormat);
HRESULT formatIndex(
long lIndex,
BSTR bstrFormat,
BSTR* pbstrFormattedString
);
Parameters
Script
- lIndex
Long integer. Integer value that is to be converted.
- bstrFormat
String. Specified numbering system. See Remarks.
C/C++
- 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.
Return Value
Script
String. Returns the integer value formatted using the specified numbering system.
C/C++
- S_OK
Value returned if successful.
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:
Requirements
Header |
msxml2.h, |
Library |
uuid.lib |