Definition

open file flags definitions.

Warning: Internal use only

Variables
constexpr size_t	OFN_READONLY
	Causes the Read Only check box to be selected initially when the dialog box is created. This flag indicates the state of the Read Only check box when the dialog box is closed.

constexpr size_t	OFN_OVERWRITEPROMPT
	Causes the Save As dialog box to generate a message box if the selected file already exists. The user must confirm whether to overwrite the file.

constexpr size_t	OFN_HIDEREADONLY
	Hides the Read Only check box.

constexpr size_t	OFN_NOCHANGEDIR
	Restores the current directory to its original value if the user changed the directory while searching for files.

constexpr size_t	OFN_SHOWHELP
	Causes the dialog box to display the Help button. The hwndOwner member must specify the window to receive the HELPMSGSTRING registered messages that the dialog box sends when the user clicks the Help button. An Explorer-style dialog box sends a CDN_HELP notification message to your hook procedure when the user clicks the Help button.

constexpr size_t	OFN_ENABLEHOOK
	Enables the hook function specified in the lpfnHook member.

constexpr size_t	OFN_ENABLETEMPLATE
	The lpTemplateName member is a pointer to the name of a dialog template resource in the module identified by the hInstance member. If the OFN_EXPLORER flag is set, the system uses the specified template to create a dialog box that is a child of the default Explorer-style dialog box. If the OFN_EXPLORER flag is not set, the system uses the template to create an old-style dialog box that replaces the default dialog box.

constexpr size_t	OFN_ENABLETEMPLATEHANDLE
	The hInstance member identifies a data block that contains a preloaded dialog box template. The system ignores lpTemplateName if this flag is specified. If the OFN_EXPLORER flag is set, the system uses the specified template to create a dialog box that is a child of the default Explorer-style dialog box. If the OFN_EXPLORER flag is not set, the system uses the template to create an old-style dialog box that replaces the default dialog box.

constexpr size_t	OFN_NOVALIDATE
	The common dialog boxes allow invalid characters in the returned file name. Typically, the calling application uses a hook procedure that checks the file name by using the FILEOKSTRING message. If the text box in the edit control is empty or contains nothing but spaces, the lists of files and directories are updated. If the text box in the edit control contains anything else, nFileOffset and nFileExtension are set to values generated by parsing the text. No default extension is added to the text, nor is text copied to the buffer specified by lpstrFileTitle. If the value specified by nFileOffset is less than zero, the file name is invalid. Otherwise, the file name is valid, and nFileExtension and nFileOffset can be used as if the OFN_NOVALIDATE flag had not been specified.

constexpr size_t	OFN_ALLOWMULTISELECT
	The File Name list box allows multiple selections. If you also set the OFN_EXPLORER flag, the dialog box uses the Explorer-style user interface; otherwise, it uses the old-style user interface.

constexpr size_t	OFN_EXTENSIONDIFFERENT
	The user typed a file name extension that differs from the extension specified by lpstrDefExt. The function does not use this flag if lpstrDefExt is NULL.

constexpr size_t	OFN_PATHMUSTEXIST
	The user can type only valid paths and file names. If this flag is used and the user types an invalid path and file name in the File Name entry field, the dialog box function displays a warning in a message box.

constexpr size_t	OFN_FILEMUSTEXIST
	The user can type only names of existing files in the File Name entry field. If this flag is specified and the user enters an invalid name, the dialog box procedure displays a warning in a message box. If this flag is specified, the OFN_PATHMUSTEXIST flag is also used. This flag can be used in an Open dialog box. It cannot be used with a Save As dialog box.

constexpr size_t	OFN_CREATEPROMPT
	If the user specifies a file that does not exist, this flag causes the dialog box to prompt the user for permission to create the file. If the user chooses to create the file, the dialog box closes and the function returns the specified name; otherwise, the dialog box remains open. If you use this flag with the OFN_ALLOWMULTISELECT flag, the dialog box allows the user to specify only one nonexistent file.

constexpr size_t	OFN_SHAREAWARE
	Specifies that if a call to the OpenFile function fails because of a network sharing violation, the error is ignored and the dialog box returns the selected file name. If this flag is not set, the dialog box notifies your hook procedure when a network sharing violation occurs for the file name specified by the user. If you set the OFN_EXPLORER flag, the dialog box sends the CDN_SHAREVIOLATION message to the hook procedure. If you do not set OFN_EXPLORER, the dialog box sends the SHAREVISTRING registered message to the hook procedure.

constexpr size_t	OFN_NOREADONLYRETURN
	The returned file does not have the Read Only check box selected and is not in a write-protected directory.

constexpr size_t	OFN_NOTESTFILECREATE
	The file is not created before the dialog box is closed. This flag should be specified if the application saves the file on a create-nonmodify network share. When an application specifies this flag, the library does not check for write protection, a full disk, an open drive door, or network protection. Applications using this flag must perform file operations carefully, because a file cannot be reopened once it is closed.

constexpr size_t	OFN_NONETWORKBUTTON
	Hides and disables the Network button.

constexpr size_t	OFN_NOLONGNAMES
	For old-style dialog boxes, this flag causes the dialog box to use short file names (8.3 format). Explorer-style dialog boxes ignore this flag and always display long file names.

constexpr size_t	OFN_EXPLORER
	Indicates that any customizations made to the Open or Save As dialog box use the Explorer-style customization methods.

constexpr size_t	OFN_NODEREFERENCELINKS
	Directs the dialog box to return the path and file name of the selected shortcut (.LNK) file. If this value is not specified, the dialog box returns the path and file name of the file referenced by the shortcut.

constexpr size_t	OFN_LONGNAMES
	For old-style dialog boxes, this flag causes the dialog box to use long file names. If this flag is not specified, or if the OFN_ALLOWMULTISELECT flag is also set, old-style dialog boxes use short file names (8.3 format) for file names with spaces. Explorer-style dialog boxes ignore this flag and always display long file names.

constexpr size_t	OFN_ENABLEINCLUDENOTIFY
	Causes the dialog box to send CDN_INCLUDEITEM notification messages to your OFNHookProc hook procedure when the user opens a folder. The dialog box sends a notification for each item in the newly opened folder. These messages enable you to control which items the dialog box displays in the folder's item list.

constexpr size_t	OFN_ENABLESIZING
	Enables the Explorer-style dialog box to be resized using either the mouse or the keyboard. By default, the Explorer-style Open and Save As dialog boxes allow the dialog box to be resized regardless of whether this flag is set. This flag is necessary only if you provide a hook procedure or custom template. The old-style dialog box does not permit resizing.

constexpr size_t	OFN_DONTADDTORECENT
	Prevents the system from adding a link to the selected file in the file system directory that contains the user's most recently used documents. To retrieve the location of this directory, call the SHGetSpecialFolderLocation function with the CSIDL_RECENT flag.

constexpr size_t	OFN_FORCESHOWHIDDEN
	Forces the showing of system and hidden files, thus overriding the user setting to show or not show hidden files. However, a file that is marked both system and hidden is not shown.

constexpr size_t	OFN_SHOWPREVIEW
	Causes the dialog box to display the preview panel.

constexpr size_t	OFN_ADDEXTENSION
	Cause the dialog box automatically adds an extension to a file name if the user omits the extension.

Variable Documentation

◆ OFN_READONLY

constexpr size_t OFN_READONLY

constexpr

#include <xtd.forms.native/include/xtd/forms/open_file_name_flags.hpp>

Causes the Read Only check box to be selected initially when the dialog box is created. This flag indicates the state of the Read Only check box when the dialog box is closed.

Library: xtd.forms.native

Remarks: For more info see https://docs.microsoft.com .

Warning: Internal use only

◆ OFN_OVERWRITEPROMPT

constexpr size_t OFN_OVERWRITEPROMPT

constexpr

#include <xtd.forms.native/include/xtd/forms/open_file_name_flags.hpp>

Causes the Save As dialog box to generate a message box if the selected file already exists. The user must confirm whether to overwrite the file.

Library: xtd.forms.native

Remarks: For more info see https://docs.microsoft.com .

Warning: Internal use only

◆ OFN_HIDEREADONLY

constexpr size_t OFN_HIDEREADONLY

constexpr

#include <xtd.forms.native/include/xtd/forms/open_file_name_flags.hpp>

Hides the Read Only check box.

Library: xtd.forms.native

Remarks: For more info see https://docs.microsoft.com .

Warning: Internal use only

◆ OFN_NOCHANGEDIR

constexpr size_t OFN_NOCHANGEDIR

constexpr

#include <xtd.forms.native/include/xtd/forms/open_file_name_flags.hpp>

Restores the current directory to its original value if the user changed the directory while searching for files.

Library: xtd.forms.native

Remarks: For more info see https://docs.microsoft.com .

Warning: Internal use only

◆ OFN_SHOWHELP

constexpr size_t OFN_SHOWHELP

constexpr

#include <xtd.forms.native/include/xtd/forms/open_file_name_flags.hpp>

Causes the dialog box to display the Help button. The hwndOwner member must specify the window to receive the HELPMSGSTRING registered messages that the dialog box sends when the user clicks the Help button. An Explorer-style dialog box sends a CDN_HELP notification message to your hook procedure when the user clicks the Help button.

Library: xtd.forms.native

Remarks: For more info see https://docs.microsoft.com .

Warning: Internal use only

◆ OFN_ENABLEHOOK

constexpr size_t OFN_ENABLEHOOK

constexpr

#include <xtd.forms.native/include/xtd/forms/open_file_name_flags.hpp>

Enables the hook function specified in the lpfnHook member.

Library: xtd.forms.native

Remarks: For more info see https://docs.microsoft.com .

Warning: Internal use only

◆ OFN_ENABLETEMPLATE

constexpr size_t OFN_ENABLETEMPLATE

constexpr

#include <xtd.forms.native/include/xtd/forms/open_file_name_flags.hpp>

The lpTemplateName member is a pointer to the name of a dialog template resource in the module identified by the hInstance member. If the OFN_EXPLORER flag is set, the system uses the specified template to create a dialog box that is a child of the default Explorer-style dialog box. If the OFN_EXPLORER flag is not set, the system uses the template to create an old-style dialog box that replaces the default dialog box.

Library: xtd.forms.native

Remarks: For more info see https://docs.microsoft.com .

Warning: Internal use only

◆ OFN_ENABLETEMPLATEHANDLE

constexpr size_t OFN_ENABLETEMPLATEHANDLE

constexpr

#include <xtd.forms.native/include/xtd/forms/open_file_name_flags.hpp>

The hInstance member identifies a data block that contains a preloaded dialog box template. The system ignores lpTemplateName if this flag is specified. If the OFN_EXPLORER flag is set, the system uses the specified template to create a dialog box that is a child of the default Explorer-style dialog box. If the OFN_EXPLORER flag is not set, the system uses the template to create an old-style dialog box that replaces the default dialog box.

Library: xtd.forms.native

Remarks: For more info see https://docs.microsoft.com .

Warning: Internal use only

◆ OFN_NOVALIDATE

constexpr size_t OFN_NOVALIDATE

constexpr

#include <xtd.forms.native/include/xtd/forms/open_file_name_flags.hpp>

The common dialog boxes allow invalid characters in the returned file name. Typically, the calling application uses a hook procedure that checks the file name by using the FILEOKSTRING message. If the text box in the edit control is empty or contains nothing but spaces, the lists of files and directories are updated. If the text box in the edit control contains anything else, nFileOffset and nFileExtension are set to values generated by parsing the text. No default extension is added to the text, nor is text copied to the buffer specified by lpstrFileTitle. If the value specified by nFileOffset is less than zero, the file name is invalid. Otherwise, the file name is valid, and nFileExtension and nFileOffset can be used as if the OFN_NOVALIDATE flag had not been specified.

Library: xtd.forms.native

Remarks: For more info see https://docs.microsoft.com .

Warning: Internal use only

◆ OFN_ALLOWMULTISELECT

constexpr size_t OFN_ALLOWMULTISELECT

constexpr

#include <xtd.forms.native/include/xtd/forms/open_file_name_flags.hpp>

The File Name list box allows multiple selections. If you also set the OFN_EXPLORER flag, the dialog box uses the Explorer-style user interface; otherwise, it uses the old-style user interface.

Library: xtd.forms.native

Remarks: For more info see https://docs.microsoft.com .

Warning: Internal use only

◆ OFN_EXTENSIONDIFFERENT

constexpr size_t OFN_EXTENSIONDIFFERENT

constexpr

#include <xtd.forms.native/include/xtd/forms/open_file_name_flags.hpp>

The user typed a file name extension that differs from the extension specified by lpstrDefExt. The function does not use this flag if lpstrDefExt is NULL.

Library: xtd.forms.native

Remarks: For more info see https://docs.microsoft.com .

Warning: Internal use only

◆ OFN_PATHMUSTEXIST

constexpr size_t OFN_PATHMUSTEXIST

constexpr

#include <xtd.forms.native/include/xtd/forms/open_file_name_flags.hpp>

The user can type only valid paths and file names. If this flag is used and the user types an invalid path and file name in the File Name entry field, the dialog box function displays a warning in a message box.

Library: xtd.forms.native

Remarks: For more info see https://docs.microsoft.com .

Warning: Internal use only

◆ OFN_FILEMUSTEXIST

constexpr size_t OFN_FILEMUSTEXIST

constexpr

#include <xtd.forms.native/include/xtd/forms/open_file_name_flags.hpp>

The user can type only names of existing files in the File Name entry field. If this flag is specified and the user enters an invalid name, the dialog box procedure displays a warning in a message box. If this flag is specified, the OFN_PATHMUSTEXIST flag is also used. This flag can be used in an Open dialog box. It cannot be used with a Save As dialog box.

Library: xtd.forms.native

Remarks: For more info see https://docs.microsoft.com .

Warning: Internal use only

◆ OFN_CREATEPROMPT

constexpr size_t OFN_CREATEPROMPT

constexpr

#include <xtd.forms.native/include/xtd/forms/open_file_name_flags.hpp>

If the user specifies a file that does not exist, this flag causes the dialog box to prompt the user for permission to create the file. If the user chooses to create the file, the dialog box closes and the function returns the specified name; otherwise, the dialog box remains open. If you use this flag with the OFN_ALLOWMULTISELECT flag, the dialog box allows the user to specify only one nonexistent file.

Library: xtd.forms.native

Remarks: For more info see https://docs.microsoft.com .

Warning: Internal use only

◆ OFN_SHAREAWARE

constexpr size_t OFN_SHAREAWARE

constexpr

#include <xtd.forms.native/include/xtd/forms/open_file_name_flags.hpp>

Specifies that if a call to the OpenFile function fails because of a network sharing violation, the error is ignored and the dialog box returns the selected file name. If this flag is not set, the dialog box notifies your hook procedure when a network sharing violation occurs for the file name specified by the user. If you set the OFN_EXPLORER flag, the dialog box sends the CDN_SHAREVIOLATION message to the hook procedure. If you do not set OFN_EXPLORER, the dialog box sends the SHAREVISTRING registered message to the hook procedure.

Library: xtd.forms.native

Remarks: For more info see https://docs.microsoft.com .

Warning: Internal use only

◆ OFN_NOREADONLYRETURN

constexpr size_t OFN_NOREADONLYRETURN

constexpr

#include <xtd.forms.native/include/xtd/forms/open_file_name_flags.hpp>

The returned file does not have the Read Only check box selected and is not in a write-protected directory.

Library: xtd.forms.native

Remarks: For more info see https://docs.microsoft.com .

Warning: Internal use only

◆ OFN_NOTESTFILECREATE

constexpr size_t OFN_NOTESTFILECREATE

constexpr

#include <xtd.forms.native/include/xtd/forms/open_file_name_flags.hpp>

The file is not created before the dialog box is closed. This flag should be specified if the application saves the file on a create-nonmodify network share. When an application specifies this flag, the library does not check for write protection, a full disk, an open drive door, or network protection. Applications using this flag must perform file operations carefully, because a file cannot be reopened once it is closed.

Library: xtd.forms.native

Remarks: For more info see https://docs.microsoft.com .

Warning: Internal use only

◆ OFN_NONETWORKBUTTON

constexpr size_t OFN_NONETWORKBUTTON

constexpr

#include <xtd.forms.native/include/xtd/forms/open_file_name_flags.hpp>

Hides and disables the Network button.

Library: xtd.forms.native

Remarks: For more info see https://docs.microsoft.com .

Warning: Internal use only

◆ OFN_NOLONGNAMES

constexpr size_t OFN_NOLONGNAMES

constexpr

#include <xtd.forms.native/include/xtd/forms/open_file_name_flags.hpp>

For old-style dialog boxes, this flag causes the dialog box to use short file names (8.3 format). Explorer-style dialog boxes ignore this flag and always display long file names.

Library: xtd.forms.native

Remarks: For more info see https://docs.microsoft.com .

Warning: Internal use only

◆ OFN_EXPLORER

constexpr size_t OFN_EXPLORER

constexpr

#include <xtd.forms.native/include/xtd/forms/open_file_name_flags.hpp>

Indicates that any customizations made to the Open or Save As dialog box use the Explorer-style customization methods.

Library: xtd.forms.native

Remarks: For more info see https://docs.microsoft.com .

Warning: Internal use only

◆ OFN_NODEREFERENCELINKS

constexpr size_t OFN_NODEREFERENCELINKS

constexpr

#include <xtd.forms.native/include/xtd/forms/open_file_name_flags.hpp>

Directs the dialog box to return the path and file name of the selected shortcut (.LNK) file. If this value is not specified, the dialog box returns the path and file name of the file referenced by the shortcut.

Library: xtd.forms.native

Remarks: For more info see https://docs.microsoft.com .

Warning: Internal use only

◆ OFN_LONGNAMES

constexpr size_t OFN_LONGNAMES

constexpr

#include <xtd.forms.native/include/xtd/forms/open_file_name_flags.hpp>

For old-style dialog boxes, this flag causes the dialog box to use long file names. If this flag is not specified, or if the OFN_ALLOWMULTISELECT flag is also set, old-style dialog boxes use short file names (8.3 format) for file names with spaces. Explorer-style dialog boxes ignore this flag and always display long file names.

Library: xtd.forms.native

Remarks: For more info see https://docs.microsoft.com .

Warning: Internal use only

◆ OFN_ENABLEINCLUDENOTIFY

constexpr size_t OFN_ENABLEINCLUDENOTIFY

constexpr

#include <xtd.forms.native/include/xtd/forms/open_file_name_flags.hpp>

Causes the dialog box to send CDN_INCLUDEITEM notification messages to your OFNHookProc hook procedure when the user opens a folder. The dialog box sends a notification for each item in the newly opened folder. These messages enable you to control which items the dialog box displays in the folder's item list.

Library: xtd.forms.native

Remarks: For more info see https://docs.microsoft.com .

Warning: Internal use only

◆ OFN_ENABLESIZING

constexpr size_t OFN_ENABLESIZING

constexpr

#include <xtd.forms.native/include/xtd/forms/open_file_name_flags.hpp>

Enables the Explorer-style dialog box to be resized using either the mouse or the keyboard. By default, the Explorer-style Open and Save As dialog boxes allow the dialog box to be resized regardless of whether this flag is set. This flag is necessary only if you provide a hook procedure or custom template. The old-style dialog box does not permit resizing.

Library: xtd.forms.native

Remarks: For more info see https://docs.microsoft.com .

Warning: Internal use only

◆ OFN_DONTADDTORECENT

constexpr size_t OFN_DONTADDTORECENT

constexpr

#include <xtd.forms.native/include/xtd/forms/open_file_name_flags.hpp>

Prevents the system from adding a link to the selected file in the file system directory that contains the user's most recently used documents. To retrieve the location of this directory, call the SHGetSpecialFolderLocation function with the CSIDL_RECENT flag.

Library: xtd.forms.native

Remarks: For more info see https://docs.microsoft.com .

Warning: Internal use only

◆ OFN_FORCESHOWHIDDEN

constexpr size_t OFN_FORCESHOWHIDDEN

constexpr

#include <xtd.forms.native/include/xtd/forms/open_file_name_flags.hpp>

Forces the showing of system and hidden files, thus overriding the user setting to show or not show hidden files. However, a file that is marked both system and hidden is not shown.

Library: xtd.forms.native

Remarks: For more info see https://docs.microsoft.com .

Warning: Internal use only

◆ OFN_SHOWPREVIEW

constexpr size_t OFN_SHOWPREVIEW

constexpr

#include <xtd.forms.native/include/xtd/forms/open_file_name_flags.hpp>

Causes the dialog box to display the preview panel.

Library: xtd.forms.native

Remarks: Added specifically for xtd.

Warning: Internal use only

◆ OFN_ADDEXTENSION

constexpr size_t OFN_ADDEXTENSION

constexpr

#include <xtd.forms.native/include/xtd/forms/open_file_name_flags.hpp>

Cause the dialog box automatically adds an extension to a file name if the user omits the extension.

Library: xtd.forms.native

Remarks: Added specifically for xtd.

Warning: Internal use only

Definition

Variables

Variable Documentation

◆ OFN_READONLY

◆ OFN_OVERWRITEPROMPT

◆ OFN_HIDEREADONLY

◆ OFN_NOCHANGEDIR

◆ OFN_SHOWHELP

◆ OFN_ENABLEHOOK

◆ OFN_ENABLETEMPLATE

◆ OFN_ENABLETEMPLATEHANDLE

◆ OFN_NOVALIDATE

◆ OFN_ALLOWMULTISELECT

◆ OFN_EXTENSIONDIFFERENT

◆ OFN_PATHMUSTEXIST

◆ OFN_FILEMUSTEXIST

◆ OFN_CREATEPROMPT

◆ OFN_SHAREAWARE

◆ OFN_NOREADONLYRETURN

◆ OFN_NOTESTFILECREATE

◆ OFN_NONETWORKBUTTON

◆ OFN_NOLONGNAMES

◆ OFN_EXPLORER

◆ OFN_NODEREFERENCELINKS

◆ OFN_LONGNAMES

◆ OFN_ENABLEINCLUDENOTIFY

◆ OFN_ENABLESIZING

◆ OFN_DONTADDTORECENT

◆ OFN_FORCESHOWHIDDEN

◆ OFN_SHOWPREVIEW

◆ OFN_ADDEXTENSION