ホーム › UI.Controls.Dialogs › GetOpenFileNameW

GetOpenFileNameW

関数

ファイルを開くための共通ダイアログを表示する(Unicode版)。

DLLCOMDLG32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// COMDLG32.dll  (Unicode / -W)
#include <windows.h>

BOOL GetOpenFileNameW(
    OPENFILENAMEW* param0
);

パラメーター

名前	型	方向	説明
param0	OPENFILENAMEW*	inout	ファイルを開くダイアログの設定と結果を保持するOPENFILENAMEW構造体へのポインタ。

戻り値の型: BOOL

公式ドキュメント

ユーザーが開くファイル (または複数のファイル) のドライブ、ディレクトリ、およびファイル名を指定できる [ファイルを開く] ダイアログボックスを作成します。(Unicode)

戻り値

型: BOOL

ユーザーがファイル名を指定して OK ボタンをクリックした場合、戻り値は 0 以外です。OPENFILENAME 構造体の lpstrFile メンバーが指すバッファーには、ユーザーが指定した完全なパスとファイル名が格納されます。

ユーザーが [ファイルを開く] ダイアログボックスをキャンセルまたは閉じた場合、あるいはエラーが発生した場合、戻り値は 0 です。拡張エラー情報を取得するには CommDlgExtendedError 関数を呼び出します。この関数は次のいずれかの値を返します。

解説(Remarks)

エクスプローラースタイルの [ファイルを開く] ダイアログボックスは、Windows エクスプローラーに似たユーザーインターフェイス機能を提供します。エクスプローラースタイルの [ファイルを開く] ダイアログボックスには、OFNHookProc フックプロシージャを指定できます。フックプロシージャを有効にするには、OPENFILENAME 構造体の Flags メンバーに OFN_EXPLORER フラグと OFN_ENABLEHOOK フラグを設定し、lpfnHook メンバーにフックプロシージャのアドレスを指定します。

Windows は、従来のスタイルのユーザーインターフェイスとの一貫性を保ちたいアプリケーションのために、従来のスタイルの [ファイルを開く] ダイアログボックスも引き続きサポートしています。従来のスタイルの [ファイルを開く] ダイアログボックスを表示するには、OFNHookProcOldStyle フックプロシージャを有効にし、OFN_EXPLORER フラグが設定されていないことを確認します。

ファイルではなくディレクトリをユーザーが選択できるダイアログボックスを表示するには、SHBrowseForFolder 関数を呼び出します。

複数のファイルを選択する場合、ファイル名の合計文字数の制限は関数のバージョンによって異なることに注意してください。

ANSI: 32k の制限
Unicode: 制限なし

例

例については、「ファイルを開く」を参照してください。

メモ

commdlg.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして GetOpenFileName を定義します。エンコードに依存しないエイリアスを、エンコードに依存するコードと混在させると、不一致が生じてコンパイルエラーまたは実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// COMDLG32.dll  (Unicode / -W)
#include <windows.h>

BOOL GetOpenFileNameW(
    OPENFILENAMEW* param0
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("COMDLG32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool GetOpenFileNameW(
    IntPtr param0   // OPENFILENAMEW* in/out
);

<DllImport("COMDLG32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function GetOpenFileNameW(
    param0 As IntPtr   ' OPENFILENAMEW* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' param0 : OPENFILENAMEW* in/out
Declare PtrSafe Function GetOpenFileNameW Lib "comdlg32" ( _
    ByVal param0 As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetOpenFileNameW = ctypes.windll.comdlg32.GetOpenFileNameW
GetOpenFileNameW.restype = wintypes.BOOL
GetOpenFileNameW.argtypes = [
    ctypes.c_void_p,  # param0 : OPENFILENAMEW* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('COMDLG32.dll')
GetOpenFileNameW = Fiddle::Function.new(
  lib['GetOpenFileNameW'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : OPENFILENAMEW* in/out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "comdlg32")]
extern "system" {
    fn GetOpenFileNameW(
        param0: *mut OPENFILENAMEW  // OPENFILENAMEW* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("COMDLG32.dll", CharSet = CharSet.Unicode)]
public static extern bool GetOpenFileNameW(IntPtr param0);
"@
$api = Add-Type -MemberDefinition $sig -Name 'COMDLG32_GetOpenFileNameW' -Namespace Win32 -PassThru
# $api::GetOpenFileNameW(param0)

#uselib "COMDLG32.dll"
#func global GetOpenFileNameW "GetOpenFileNameW" wptr
; GetOpenFileNameW varptr(param0)   ; 戻り値は stat
; param0 : OPENFILENAMEW* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "COMDLG32.dll"
#cfunc global GetOpenFileNameW "GetOpenFileNameW" var
; res = GetOpenFileNameW(param0)
; param0 : OPENFILENAMEW* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "COMDLG32.dll"
#cfunc global GetOpenFileNameW "GetOpenFileNameW" sptr
; res = GetOpenFileNameW(varptr(param0))
; param0 : OPENFILENAMEW* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。