LPDISPLAYVAL Callback Function

Windows Installer

LPDISPLAYVAL Callback Function

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

C++BOOL CALLBACK 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.

uiType [in]

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.

 

szwVal [in]

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

szwDescription [in]

The message text.

szwLocation [in]

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

VersionEvalcom2.dll version 3.0.3790.371 or later
HeaderEvalcom2.h

See Also

IValidate
Using Evalcom2
Validation Callback Functions

Send comments about this topic to Microsoft

Build date: 8/13/2009

© 2009 Microsoft Corporation. All rights reserved.