IDataFunctions_4_0::ValidateNumber Method [C++]

  • Article

Use this method to check whether a string representation of a number is valid, and optionally to check the value of the number against a specified range.

Definition

[C++]

HRESULT IDataFunctions_4_0::ValidateNumber(VARIANTvtNumber,
 VARIANTvtMin,
 VARIANTvtMax,
 VARIANT*pvtValid);

[Visual Basic]

Function ValidateNumber(vtNumber As Variant,
 vtMin As Variant,
 vtMax As Variant) As Variant

Parameters

  • vtNumber[C++]
    [in] A VARIANT that contains a string representation of a number to validate.
  • vtNumber[Visual Basic]
    A Variant that contains a string representation of a number to validate.
  • vtMin[C++]
    [in] A VARIANT that contains a value specifying the low end of the range. The default value for this parameter is NULL, which means that the vtMin parameter is ignored in the range validation.
  • vtMin[Visual Basic]
    A Variant that contains a value specifying the low end of the range. The default value for this parameter is NULL, which means that the vtMin parameter is ignored in the range validation.
  • vtMax[C++]
    [in] A VARIANT that contains a value specifying the high end of the range. The default value for the vtMax parameteris NULL, which means that this parameteris ignored in the range validation.
  • vtMax[Visual Basic]
    A Variant that contains a value specifying the high end of the range. The default value for the vtMax parameteris NULL, which means that this parameteris ignored in the range validation.
  • pvtValid[C++]
    [out, retval] A pointer to a VARIANT used to return a Boolean that indicates whether the vtNumber parameter is valid. A value of TRUE indicates the vtNumber parameter is a valid whole number, and that it is within the given range, if any.

Return Values

[C++] This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.

[Visual Basic] If this method completes successfully, it returns a Boolean Variant that indicates whether the vtNumber parameter is valid. A value of TRUE indicates the vtNumber parameter is a valid whole number, and that it is within the given range, if any.

Error Values

[C++] This method returns S_OK (0x00000000) to indicate success and standard COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object, which can be accessed using the API function GetErrorInfo. In particular, the GetDescription method of the IErrorInfo interface may return a text description of the error.

[Visual Basic] This method sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to standard COM error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.

Remarks

[C++] The pvtValid parameter contains valid data only if the method completes successfully.

For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.

[Visual Basic]

Example

<HTML>
<HEAD>
</HEAD>
<BODY>
<%
Dim Result
Dim Amount
Set MSCSDataFunctions = Server.CreateObject("Commerce.DataFunctions")
' Set Locale to USA
MSCSDataFunctions.Locale = myLocale
myInt = 24
Result = MSCSDataFunctions.ValidateNumber(myInt , 1, 10)
Response.Write myInt & " Is this integer between 1 & 10?: " & _
    " " & Result & "<P>"
myInt = 2
Result = MSCSDataFunctions.ValidateNumber(myInt , 1, 10)
Response.Write myInt & " Is this integer between 1 & 10?: " & _
    " " & Result & "<P>"
%>
</BODY>
</HTML>

See Also

[C++]DataFunctions Object

[C++]IDataFunctions_4_0::Number

[C++]IDataFunctions_4_0::ConvertNumberString

[Visual Basic]DataFunctions Object

[Visual Basic]DataFunctions.Number

[Visual Basic]DataFunctions.ConvertNumberString

Copyright © 2005 Microsoft Corporation.
All rights reserved.