Windows Dev Center

VarParseNumFromStr Function

Parses a string, and creates a type-independent description of the number it represents.

The VarParseNumFromStr function fills in the dwOutFlags element with each corresponding feature that was actually found in the string. This allows the caller to make decisions about what numeric type to use for the number, based on the format in which it was entered. For example, one application might want to use the CURRENCY data type if the currency symbol is used, and others may want to force a floating point type if an exponent was used.

HRESULT VarParseNumFromStr(  
  OLECHAR*  strIn,     
  LCID  lcid,          
  unsigned long  dwFlags,  
  NUMPARSE*  pnumprs,  
  unsigned char*  rgbDig  
);

strIn

[in] Input string to be converted to a number.

lcid

[in] Locale identifier.

dwFlags

[in] Allows the caller to control parsing, therefore defining the acceptable syntax of a number. If this field is set to zero, the input string must contain nothing but decimal digits. Setting each defined flag bit enables parsing of that syntactic feature. Standard Automation parsing (for example, as used by VarI2FromStr) has all flags set (NUMPRS_STD).

pnumprs

[in] Parsed results.

rgbDig

[out] The rgbDig array is filled in with the values for the digits in the range 0–7, 0–9, or 0–15, depending on whether the number is octal, decimal, or hexadecimal. All leading zeros have been stripped off. For decimal numbers, trailing zeros are also stripped off, unless the number is zero, in which case a single zero digit will be present.

The return value obtained from the returned HRESULT is one of the following.

Value

Meaning

S_OK

Success.

E_OUTOFMEMORY

Internal memory allocation failed. (Used for DBCS only to create a copy with all wide characters mapped narrow.)

DISP_E_TYPEMISMATCH

There is no valid number in the string, or there is no closing parenthesis to match an opening one. In the former case, cDig and cchUsed in the NUMPARSE structure will be zero. In the latter, the NUMPARSE structure and digit array are fully updated, as if the closing parenthesis was present.

DISP_E_OVERFLOW

For hexadecimal and octal digits, there are more digits than will fit into the array. For decimal, the exponent exceeds the maximum possible. In both cases, the NUMPARSE structure and digit array are fully updated (for decimal, the cchUsed field excludes the entire exponent).

Show:
© 2015 Microsoft