Admin Production ni-theme
Current Publication

PromptPopup

LabWindows/CVI

PromptPopup

int PromptPopup (char title[], char message[], char responseBuffer[], size_t maxResponseLength);

Purpose

Displays a prompt message in a dialog box and waits for the user to enter a reply.

Parameters

Input
Name Type Description
title char [] Title of the dialog box.
message char [] Message to display in the dialog box.

To display a multi-line message, embed newline characters (\n) in the message string.
maxResponseLength size_t Maximum number of bytes the user is allowed to enter.

The responseBuffer must be large enough to contain all of the user input plus one ASCII NUL byte.
Output
Name Type Description
responseBuffer char [] Buffer in which to store the user response.

The buffer must be large enough to hold maxResponseLength bytes plus one ASCII NUL byte.

Return Value

Name Type Description
status int Return value indicating whether the function was successful. A negative number indicates that an error occurred.

Code Description
0 Success.
VAL_USER_CANCEL The user canceled the operation.

Additional Information

Library: User Interface Library

Include file: userint.h

LabWindows/CVI compatibility: LabWindows/CVI 3.0 and later

Examples

Refer to the following examples that use the PromptPopup function:

  • dll\basic\cvidll.cws

    Open example
  • rs232\commcallback.cws

    Open example
  • userint\popups.cws

    Open example