OPENFILENAMEW class final

Struct from Win32 API that contains parameters for the GetOpenFileNameW function and receives information about the file(s) selected by the user.

Reference: https://docs.microsoft.com/en-us/windows/win32/api/commdlg/ns-commdlg-openfilenamew

Inheritance

Constructors

OPENFILENAMEW()

Properties

dwReserved ↔ int
This member is reserved.
getter/setter pair
flags ↔ int
A set of bit flags you can use to initialize the dialog box. When the dialog box returns, it sets these flags to indicate the user's input.
getter/setter pair
flagsEx ↔ int
A set of bit flags you can use to initialize the dialog box.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
hInstance ↔ Pointer<NativeType>
If the OFN_ENABLETEMPLATEHANDLE flag is set in the Flags member, hInstance is a handle to a memory object containing a dialog box template. If the OFN_ENABLETEMPLATE flag is set, hInstance is a handle to a module that contains a dialog box template named by the lpTemplateName member. If neither flag is set, this member is ignored. 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.
getter/setter pair
hwndOwner ↔ Pointer<NativeType>
A handle to the window that owns the dialog box. This member can be any valid window handle, or it can be null if the dialog box has no owner.
getter/setter pair
lCustData ↔ Pointer<NativeType>
Application-defined data that the system passes to the hook procedure identified by the lpfnHook member. When the system sends the WM_INITDIALOG message to the hook procedure, the message's lParam parameter is a pointer to the OPENFILENAME structure specified when the dialog box was created. The hook procedure can use this pointer to get the lCustData value.
getter/setter pair
lpfnHook ↔ Pointer<NativeType>
A pointer to a hook procedure. This member is ignored unless the Flags member includes the OFN_ENABLEHOOK flag.
getter/setter pair
lpstrCustomFilter ↔ Pointer<Utf16>
A static buffer that contains a pair of null-terminated filter strings for preserving the filter pattern chosen by the user.
getter/setter pair
lpstrDefExt ↔ Pointer<Utf16>
The default extension. GetOpenFileName and GetSaveFileName append this extension to the file name if the user fails to type an extension.
getter/setter pair
lpstrFile ↔ Pointer<Utf16>
The file name used to initialize the File Name edit control. The first character of this buffer must be null if initialization is not necessary.
getter/setter pair
lpstrFileTitle ↔ Pointer<Utf16>
The file name and extension (without path information) of the selected file. This member can be null.
getter/setter pair
lpstrFilter ↔ Pointer<Utf16>
A buffer containing pairs of null-terminated filter strings. The last string in the buffer must be terminated by two null characters.
getter/setter pair
lpstrInitialDir ↔ Pointer<Utf16>
The initial directory. The algorithm for selecting the initial directory varies on different platforms.
getter/setter pair
lpstrTitle ↔ Pointer<Utf16>
A string to be placed in the title bar of the dialog box. If this member is null, the system uses the default title (that is, Save As or Open).
getter/setter pair
lpTemplateName ↔ Pointer<Utf16>
The name of the dialog template resource in the module identified by the hInstance member. For numbered dialog box resources, this can be a value returned by the MAKEINTRESOURCE macro. This member is ignored unless the OFN_ENABLETEMPLATE flag is set in the Flags 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.
getter/setter pair
lStructSize ↔ int
The length, in bytes, of the structure. Use sizeof OPENFILENAMEW for this parameter.
getter/setter pair
nFileExtension ↔ int
The zero-based offset, in characters, from the beginning of the path to the file name extension in the string pointed to by lpstrFile.
getter/setter pair
nFileOffset ↔ int
The zero-based offset, in characters, from the beginning of the path to the file name in the string pointed to by lpstrFile.
getter/setter pair
nFilterIndex ↔ int
The index of the currently selected filter in the File Types control.
getter/setter pair
nMaxCustFilter ↔ int
The size, in characters, of the buffer identified by lpstrCustomFilter. This buffer should be at least 40 characters long. This member is ignored if lpstrCustomFilter is null or points to a null string.
getter/setter pair
nMaxFile ↔ int
The size, in characters, of the buffer pointed to by lpstrFile. The buffer must be large enough to store the path and file name string or strings, including the terminating null character. The GetOpenFileName and GetSaveFileName functions return false if the buffer is too small to contain the file information. The buffer should be at least 256 characters long.
getter/setter pair
nMaxFileTitle ↔ int
The size, in characters, of the buffer pointed to by lpstrFileTitle. This member is ignored if lpstrFileTitle is null.
getter/setter pair
pvReserved ↔ Pointer<NativeType>
This member is reserved.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited