Edit

FINDMSGSTRING message

  • Article

A Find or Replace dialog box sends the FINDMSGSTRING registered message to the window procedure of its owner window when the user clicks the Find Next, Replace, or Replace All button, or closes the dialog box.

#define FINDMSGSTRING TEXT("commdlg_FindReplace")

Parameters

wParam

This parameter is not used.

lParam

A pointer to a FINDREPLACE structure. The members of this structure contain the latest user input, including the string to search for, the replacement string (if any) and the search-and-replacement options.

Return value

This message has no return value.

Remarks

You must specify the FINDMSGSTRING constant in a call to the RegisterWindowMessage function to get the identifier for the message sent by the dialog box.

When you create the dialog box, use the hwndOwner member of the FINDREPLACE structure to identify the window to receive FINDMSGSTRING messages.

The Flags member of the FINDREPLACE structure includes one of the following flags to indicate the event that caused the message.

Flag Meaning
FR_DIALOGTERM (0x00000040) The dialog box is closing. After the owner window processes this message, a handle to the dialog box is no longer valid.
FR_FINDNEXT (0x00000008) The user clicked the Find Next button in a Find or Replace dialog box. The lpstrFindWhat member specifies the string to search for.
FR_REPLACE (0x00000010) The user clicked the Replace button in a Replace dialog box. The lpstrFindWhat member specifies the string to replace and the lpstrReplaceWith member specifies the replacement string.
FR_REPLACEALL (0x00000020) The user clicked the Replace All button in a Replace dialog box. The lpstrFindWhat member specifies the string to replace and the lpstrReplaceWith member specifies the replacement string.

For a Find Next or Replace All message, the Flags member can include one or more of the following flags to indicate the search options.

Flag Meaning
FR_DOWN (0x00000001) If set, the Down button of the direction radio buttons is selected indicating that user wants to search from the current location to the end of the document. If FR_DOWN is not set, the Up button is selected so the user wants to search to the beginning of the document.
FR_MATCHCASE (0x00000004) If set, the Match Case check box is selected indicating that the user wants the search to be case-sensitive. If FR_MATCHCASE is not set, the check box is unselected so the search should be case-insensitive.
FR_WHOLEWORD (0x00000002) If set, the Match Whole Word Only check box is selected indicating that the user wants to search only for whole words that match the search string. If FR_WHOLEWORD is not set, the check box is unselected so you should also search for word fragments that match the search string.

Requirements

Requirement Value
Minimum supported client
 Windows 2000 Professional [desktop apps only]
Minimum supported server
 Windows 2000 Server [desktop apps only]
Header
Commdlg.h (include Windows.h)
Unicode and ANSI names
 FINDMSGSTRINGW (Unicode) and FINDMSGSTRINGA (ANSI)

See also

Reference

FINDREPLACE

RegisterWindowMessage

Conceptual

Common Dialog Box Library