Win32 API 日本語リファレンス
ホームUI.Shell › AssocQueryKeyW

AssocQueryKeyW

関数
ファイル関連付けに対応するレジストリキーを取得する。
DLLSHLWAPI.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT AssocQueryKeyW(
    ASSOCF flags,
    ASSOCKEY key,
    LPCWSTR pszAssoc,
    LPCWSTR pszExtra,   // optional
    HKEY* phkeyOut
);

パラメーター

名前方向説明
flagsASSOCFin検索を制御するために使用できるフラグです。ASSOCF 値の任意の組み合わせを指定できますが、ASSOCF_INIT 値は 1 つしか含められません。
keyASSOCKEYin返されるキーの種類を指定する ASSOCKEY 値です。
pszAssocLPCWSTRin

ルートキーを特定するために使用する、null で終わる文字列へのポインターです。4 種類の文字列を使用できます。

ファイル名拡張子

.txt などのファイル名拡張子です。

CLSID

標準の "{GUID}" 形式の CLSID GUID です。

ProgID

Word.Document.8 などのアプリケーションの ProgID です。

実行可能ファイル名

アプリケーションの .exe ファイルの名前です。flagsASSOCF_OPEN_BYEXENAME フラグを設定する必要があります。

pszExtraLPCWSTRinoptional文字列の場所に関する追加情報を含む、省略可能な null で終わる文字列へのポインターです。通常は open などのシェル動詞 (verb) に設定します。使用しない場合はこのパラメーターを NULL に設定します。
phkeyOutHKEY*out

キーの HKEY 値へのポインターです。

- pszAssoc.CLSID

標準の "{GUID}" 形式の CLSID GUID です。

- pszAssoc.実行可能ファイル名

アプリケーションの .exe ファイルの名前です。flagsASSOCF_OPEN_BYEXENAME フラグを設定する必要があります。

- pszAssoc.ファイル名拡張子

.txt などのファイル名拡張子です。

- pszAssoc.ProgID

Word.Document.8 などのアプリケーションの ProgID です。

戻り値の型: HRESULT

公式ドキュメント

ファイルまたはプロトコルの関連付けに関連するキーをレジストリから検索して取得します。(Unicode)

戻り値

型: HRESULT

成功した場合は S_OK を、それ以外の場合は COM エラー値を返します。

解説(Remarks)

この関数は IQueryAssociations インターフェイスのラッパーです。このインターフェイスを使用する処理を簡略化することを目的としています。ファイルおよびプロトコルの関連付け関数の動作に関する詳細については、IQueryAssociations を参照してください。

メモ

shlwapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして AssocQueryKey を定義します。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると、不整合が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規則を参照してください。

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

各言語での呼び出し定義

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

HRESULT AssocQueryKeyW(
    ASSOCF flags,
    ASSOCKEY key,
    LPCWSTR pszAssoc,
    LPCWSTR pszExtra,   // optional
    HKEY* phkeyOut
);
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int AssocQueryKeyW(
    uint flags,   // ASSOCF
    int key,   // ASSOCKEY
    [MarshalAs(UnmanagedType.LPWStr)] string pszAssoc,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string pszExtra,   // LPCWSTR optional
    IntPtr phkeyOut   // HKEY* out
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function AssocQueryKeyW(
    flags As UInteger,   ' ASSOCF
    key As Integer,   ' ASSOCKEY
    <MarshalAs(UnmanagedType.LPWStr)> pszAssoc As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> pszExtra As String,   ' LPCWSTR optional
    phkeyOut As IntPtr   ' HKEY* out
) As Integer
End Function
' flags : ASSOCF
' key : ASSOCKEY
' pszAssoc : LPCWSTR
' pszExtra : LPCWSTR optional
' phkeyOut : HKEY* out
Declare PtrSafe Function AssocQueryKeyW Lib "shlwapi" ( _
    ByVal flags As Long, _
    ByVal key As Long, _
    ByVal pszAssoc As LongPtr, _
    ByVal pszExtra As LongPtr, _
    ByVal phkeyOut 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

AssocQueryKeyW = ctypes.windll.shlwapi.AssocQueryKeyW
AssocQueryKeyW.restype = ctypes.c_int
AssocQueryKeyW.argtypes = [
    wintypes.DWORD,  # flags : ASSOCF
    ctypes.c_int,  # key : ASSOCKEY
    wintypes.LPCWSTR,  # pszAssoc : LPCWSTR
    wintypes.LPCWSTR,  # pszExtra : LPCWSTR optional
    ctypes.c_void_p,  # phkeyOut : HKEY* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
AssocQueryKeyW = Fiddle::Function.new(
  lib['AssocQueryKeyW'],
  [
    -Fiddle::TYPE_INT,  # flags : ASSOCF
    Fiddle::TYPE_INT,  # key : ASSOCKEY
    Fiddle::TYPE_VOIDP,  # pszAssoc : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pszExtra : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # phkeyOut : HKEY* out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "shlwapi")]
extern "system" {
    fn AssocQueryKeyW(
        flags: u32,  // ASSOCF
        key: i32,  // ASSOCKEY
        pszAssoc: *const u16,  // LPCWSTR
        pszExtra: *const u16,  // LPCWSTR optional
        phkeyOut: *mut *mut core::ffi::c_void  // HKEY* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode)]
public static extern int AssocQueryKeyW(uint flags, int key, [MarshalAs(UnmanagedType.LPWStr)] string pszAssoc, [MarshalAs(UnmanagedType.LPWStr)] string pszExtra, IntPtr phkeyOut);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_AssocQueryKeyW' -Namespace Win32 -PassThru
# $api::AssocQueryKeyW(flags, key, pszAssoc, pszExtra, phkeyOut)
#uselib "SHLWAPI.dll"
#func global AssocQueryKeyW "AssocQueryKeyW" wptr, wptr, wptr, wptr, wptr
; AssocQueryKeyW flags, key, pszAssoc, pszExtra, phkeyOut   ; 戻り値は stat
; flags : ASSOCF -> "wptr"
; key : ASSOCKEY -> "wptr"
; pszAssoc : LPCWSTR -> "wptr"
; pszExtra : LPCWSTR optional -> "wptr"
; phkeyOut : HKEY* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SHLWAPI.dll"
#cfunc global AssocQueryKeyW "AssocQueryKeyW" int, int, wstr, wstr, sptr
; res = AssocQueryKeyW(flags, key, pszAssoc, pszExtra, phkeyOut)
; flags : ASSOCF -> "int"
; key : ASSOCKEY -> "int"
; pszAssoc : LPCWSTR -> "wstr"
; pszExtra : LPCWSTR optional -> "wstr"
; phkeyOut : HKEY* out -> "sptr"
; HRESULT AssocQueryKeyW(ASSOCF flags, ASSOCKEY key, LPCWSTR pszAssoc, LPCWSTR pszExtra, HKEY* phkeyOut)
#uselib "SHLWAPI.dll"
#cfunc global AssocQueryKeyW "AssocQueryKeyW" int, int, wstr, wstr, intptr
; res = AssocQueryKeyW(flags, key, pszAssoc, pszExtra, phkeyOut)
; flags : ASSOCF -> "int"
; key : ASSOCKEY -> "int"
; pszAssoc : LPCWSTR -> "wstr"
; pszExtra : LPCWSTR optional -> "wstr"
; phkeyOut : HKEY* out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procAssocQueryKeyW = shlwapi.NewProc("AssocQueryKeyW")
)

// flags (ASSOCF), key (ASSOCKEY), pszAssoc (LPCWSTR), pszExtra (LPCWSTR optional), phkeyOut (HKEY* out)
r1, _, err := procAssocQueryKeyW.Call(
	uintptr(flags),
	uintptr(key),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszAssoc))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszExtra))),
	uintptr(phkeyOut),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function AssocQueryKeyW(
  flags: DWORD;   // ASSOCF
  key: Integer;   // ASSOCKEY
  pszAssoc: PWideChar;   // LPCWSTR
  pszExtra: PWideChar;   // LPCWSTR optional
  phkeyOut: Pointer   // HKEY* out
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'AssocQueryKeyW';
result := DllCall("SHLWAPI\AssocQueryKeyW"
    , "UInt", flags   ; ASSOCF
    , "Int", key   ; ASSOCKEY
    , "WStr", pszAssoc   ; LPCWSTR
    , "WStr", pszExtra   ; LPCWSTR optional
    , "Ptr", phkeyOut   ; HKEY* out
    , "Int")   ; return: HRESULT
●AssocQueryKeyW(flags, key, pszAssoc, pszExtra, phkeyOut) = DLL("SHLWAPI.dll", "int AssocQueryKeyW(dword, int, char*, char*, void*)")
# 呼び出し: AssocQueryKeyW(flags, key, pszAssoc, pszExtra, phkeyOut)
# flags : ASSOCF -> "dword"
# key : ASSOCKEY -> "int"
# pszAssoc : LPCWSTR -> "char*"
# pszExtra : LPCWSTR optional -> "char*"
# phkeyOut : HKEY* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "shlwapi" fn AssocQueryKeyW(
    flags: u32, // ASSOCF
    key: i32, // ASSOCKEY
    pszAssoc: [*c]const u16, // LPCWSTR
    pszExtra: [*c]const u16, // LPCWSTR optional
    phkeyOut: ?*anyopaque // HKEY* out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc AssocQueryKeyW(
    flags: uint32,  # ASSOCF
    key: int32,  # ASSOCKEY
    pszAssoc: WideCString,  # LPCWSTR
    pszExtra: WideCString,  # LPCWSTR optional
    phkeyOut: pointer  # HKEY* out
): int32 {.importc: "AssocQueryKeyW", stdcall, dynlib: "SHLWAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "shlwapi");
extern(Windows)
int AssocQueryKeyW(
    uint flags,   // ASSOCF
    int key,   // ASSOCKEY
    const(wchar)* pszAssoc,   // LPCWSTR
    const(wchar)* pszExtra,   // LPCWSTR optional
    void* phkeyOut   // HKEY* out
);
ccall((:AssocQueryKeyW, "SHLWAPI.dll"), stdcall, Int32,
      (UInt32, Int32, Cwstring, Cwstring, Ptr{Cvoid}),
      flags, key, pszAssoc, pszExtra, phkeyOut)
# flags : ASSOCF -> UInt32
# key : ASSOCKEY -> Int32
# pszAssoc : LPCWSTR -> Cwstring
# pszExtra : LPCWSTR optional -> Cwstring
# phkeyOut : HKEY* out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t AssocQueryKeyW(
    uint32_t flags,
    int32_t key,
    const uint16_t* pszAssoc,
    const uint16_t* pszExtra,
    void* phkeyOut);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.AssocQueryKeyW(flags, key, pszAssoc, pszExtra, phkeyOut)
-- flags : ASSOCF
-- key : ASSOCKEY
-- pszAssoc : LPCWSTR
-- pszExtra : LPCWSTR optional
-- phkeyOut : HKEY* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const AssocQueryKeyW = lib.func('__stdcall', 'AssocQueryKeyW', 'int32_t', ['uint32_t', 'int32_t', 'str16', 'str16', 'void *']);
// AssocQueryKeyW(flags, key, pszAssoc, pszExtra, phkeyOut)
// flags : ASSOCF -> 'uint32_t'
// key : ASSOCKEY -> 'int32_t'
// pszAssoc : LPCWSTR -> 'str16'
// pszExtra : LPCWSTR optional -> 'str16'
// phkeyOut : HKEY* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  AssocQueryKeyW: { parameters: ["u32", "i32", "buffer", "buffer", "pointer"], result: "i32" },
});
// lib.symbols.AssocQueryKeyW(flags, key, pszAssoc, pszExtra, phkeyOut)
// flags : ASSOCF -> "u32"
// key : ASSOCKEY -> "i32"
// pszAssoc : LPCWSTR -> "buffer"
// pszExtra : LPCWSTR optional -> "buffer"
// phkeyOut : HKEY* out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t AssocQueryKeyW(
    uint32_t flags,
    int32_t key,
    const uint16_t* pszAssoc,
    const uint16_t* pszExtra,
    void* phkeyOut);
C, "SHLWAPI.dll");
// $ffi->AssocQueryKeyW(flags, key, pszAssoc, pszExtra, phkeyOut);
// flags : ASSOCF
// key : ASSOCKEY
// pszAssoc : LPCWSTR
// pszExtra : LPCWSTR optional
// phkeyOut : HKEY* out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Shlwapi extends StdCallLibrary {
    Shlwapi INSTANCE = Native.load("shlwapi", Shlwapi.class, W32APIOptions.UNICODE_OPTIONS);
    int AssocQueryKeyW(
        int flags,   // ASSOCF
        int key,   // ASSOCKEY
        WString pszAssoc,   // LPCWSTR
        WString pszExtra,   // LPCWSTR optional
        Pointer phkeyOut   // HKEY* out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("shlwapi")]
lib LibSHLWAPI
  fun AssocQueryKeyW = AssocQueryKeyW(
    flags : UInt32,   # ASSOCF
    key : Int32,   # ASSOCKEY
    pszAssoc : UInt16*,   # LPCWSTR
    pszExtra : UInt16*,   # LPCWSTR optional
    phkeyOut : Void*   # HKEY* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef AssocQueryKeyWNative = Int32 Function(Uint32, Int32, Pointer<Utf16>, Pointer<Utf16>, Pointer<Void>);
typedef AssocQueryKeyWDart = int Function(int, int, Pointer<Utf16>, Pointer<Utf16>, Pointer<Void>);
final AssocQueryKeyW = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<AssocQueryKeyWNative, AssocQueryKeyWDart>('AssocQueryKeyW');
// flags : ASSOCF -> Uint32
// key : ASSOCKEY -> Int32
// pszAssoc : LPCWSTR -> Pointer<Utf16>
// pszExtra : LPCWSTR optional -> Pointer<Utf16>
// phkeyOut : HKEY* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function AssocQueryKeyW(
  flags: DWORD;   // ASSOCF
  key: Integer;   // ASSOCKEY
  pszAssoc: PWideChar;   // LPCWSTR
  pszExtra: PWideChar;   // LPCWSTR optional
  phkeyOut: Pointer   // HKEY* out
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'AssocQueryKeyW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "AssocQueryKeyW"
  c_AssocQueryKeyW :: Word32 -> Int32 -> CWString -> CWString -> Ptr () -> IO Int32
-- flags : ASSOCF -> Word32
-- key : ASSOCKEY -> Int32
-- pszAssoc : LPCWSTR -> CWString
-- pszExtra : LPCWSTR optional -> CWString
-- phkeyOut : HKEY* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let assocquerykeyw =
  foreign "AssocQueryKeyW"
    (uint32_t @-> int32_t @-> (ptr uint16_t) @-> (ptr uint16_t) @-> (ptr void) @-> returning int32_t)
(* flags : ASSOCF -> uint32_t *)
(* key : ASSOCKEY -> int32_t *)
(* pszAssoc : LPCWSTR -> (ptr uint16_t) *)
(* pszExtra : LPCWSTR optional -> (ptr uint16_t) *)
(* phkeyOut : HKEY* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("AssocQueryKeyW" assoc-query-key-w :convention :stdcall) :int32
  (flags :uint32)   ; ASSOCF
  (key :int32)   ; ASSOCKEY
  (psz-assoc (:string :encoding :utf-16le))   ; LPCWSTR
  (psz-extra (:string :encoding :utf-16le))   ; LPCWSTR optional
  (phkey-out :pointer))   ; HKEY* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $AssocQueryKeyW = Win32::API::More->new('SHLWAPI',
    'int AssocQueryKeyW(DWORD flags, int key, LPCWSTR pszAssoc, LPCWSTR pszExtra, HANDLE phkeyOut)');
# my $ret = $AssocQueryKeyW->Call($flags, $key, $pszAssoc, $pszExtra, $phkeyOut);
# flags : ASSOCF -> DWORD
# key : ASSOCKEY -> int
# pszAssoc : LPCWSTR -> LPCWSTR
# pszExtra : LPCWSTR optional -> LPCWSTR
# phkeyOut : HKEY* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
使用する型