OnError

CNi

Function Group
OnError() Functions    Prev page: OnDblClickNext page: OnIncDecButtonClicked    
Function Declared in:
NiNumEditEvents.h

'Declaration' icon -- Shortcut to top of page. Declaration

void OnError(
    short Number,
    BSTR FAR* Description,
    long Scode,
    LPCTSTR Source,
    LPCTSTR HelpFile,
    long HelpContext,
    BOOL FAR* CancelDisplay);

'Description' icon -- Shortcut to top of page. Description

Generated when the user enters an illegal value in the numeric edit control.

Shortcut to top of page. Parameters

short Number

The lower 16-bits of the Scode value.

BSTR FAR* Description

The error description returned by the control. By default, this parameter returns one of three strings: "Type Mismatch", "Out of Present Range", or "Invalid Input". You can override these values by providing your error description inside the error event handler. If CancelDisplay is set to TRUE, no error messages are displayed.

long Scode

The Windows error code number.

LPCTSTR Source

Name of the application that generated the error.

LPCTSTR HelpFile

Associated help file.

Note: Currently not supported by Measurement Studio tools for Visual C++.

long HelpContext

Help context for error.

Note: Currently not supported by Measurement Studio tools for Visual C++.

BOOL FAR* CancelDisplay

Displays error descriptions in a message box when set to FALSE (default value). It set to TRUE, the control does not display the Description parameter default values or any values you specify for Description.

'See Also' icon -- Shortcut to top of page. See Also