SHAREVISTRING message

[Starting with Windows Vista, the Open and Save As common dialog boxes have been superseded by the Common Item Dialog. We recommended that you use the Common Item Dialog API instead of these dialog boxes from the Common Dialog Box Library.]

An Open or Save As dialog box sends the SHAREVISTRING registered message to your hook procedure, OFNHookProc, if a sharing violation occurs for the selected file when the user clicks the OK button.


#define SHAREVISTRING TEXT("commdlg_ShareViolation")

Parameters

wParam

This parameter is not used.

lParam

A pointer to a OPENFILENAME structure. The lpstrFile member of this structure contains the file name that caused the sharing violation.

Return value

The hook procedure must return one of the following values to indicate how the dialog box should handle the sharing violation.

Return code/valueDescription
OFN_SHAREFALLTHROUGH
2

Accept the file name

OFN_SHARENOWARN
1

Reject the file name but do not warn the user. The application is responsible for displaying a warning message.

OFN_SHAREWARN
0

Reject the file name and displays a warning message (the same result as if there were no hook procedure).

 

Remarks

The hook procedure must specify the SHAREVISTRING constant in a call to the RegisterWindowMessage function to get the identifier for the message sent by the dialog box.

The dialog box sends the SHAREVISTRING registered message only if you did not specify the OFN_SHAREAWARE flag in the Flags member of the OPENFILENAME structure when you created the dialog.

If the hook procedure returns an undefined value, the dialog box responds as if OFN_SHAREWARN was returned.

Requirements

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

SHAREVISTRINGW (Unicode) and SHAREVISTRINGA (ANSI)

See also

Reference
CDN_SHAREVIOLATION
OPENFILENAME
RegisterWindowMessage
Conceptual
Common Dialog Box Library

 

 

Community Additions

ADD
Show:
© 2014 Microsoft