Edit

Share via

LPDISPLAYVAL callback function (evalcom2.h)

  • Article

The LPDISPLAYVAL function specification defines a callback function prototype. The IValidate::SetDisplay method enables an authoring tool to receive ICE status messages through the registered callback function.

Syntax

LPDISPLAYVAL Lpdisplayval;

BOOL Lpdisplayval(
       LPVOID pContext,
  [in] RESULTTYPES uiType,
  [in] LPCWSTR szwVal,
  [in] LPCWSTR szwDescription,
  [in] LPCWSTR szwLocation
)
{...}

Parameters

pContext

A pointer to an application context passed to the SetDisplay method.

This parameter can be used for error checking.

[in] uiType

Specifies the type of message sent by the ICE.

This parameter can be one of the following values.

Value Meaning
ieUnknown
0
 Unknown ICE message.
ieError
1
 ICE error message.
ieWarning
2
 ICE warning message.
ieInfo
3
 ICE information message.

[in] szwVal

The name of the ICE reporting the message, or an error reported by evalcom2 during validation.

[in] szwDescription

The message text.

[in] szwLocation

The location of the error.

This parameter can be NULL if the error does not refer to an actual database table or row. Specify the location of the error using the following format: Table\tColumn\tPrimaryKey1[\tPrimaryKey2\ . . .].

Return value

Return code/value Description
TRUE
1
 Validation procedure should continue.
FALSE
0
 Validation was canceled. The callback function return FALSE to stop validation.

Requirements

Requirement Value
Minimum supported client Evalcom2.dll version 3.0.3790.371 or later
Target Platform Windows
Header evalcom2.h

See also

IValidate

Using Evalcom2

Validation Callback Functions