ホーム › UI.Shell › AssocQueryStringByKeyA

AssocQueryStringByKeyA

関数

レジストリキー指定で関連付けの文字列情報を取得する。

DLLSHLWAPI.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// SHLWAPI.dll  (ANSI / -A)
#include <windows.h>

HRESULT AssocQueryStringByKeyA(
    ASSOCF flags,
    ASSOCSTR str,
    HKEY hkAssoc,
    LPCSTR pszExtra,   // optional
    LPSTR pszOut,   // optional
    DWORD* pcchOut
);

パラメーター

名前	型	方向	説明
flags	ASSOCF	in	検索を制御するために使用できるフラグです。ASSOCF 値の任意の組み合わせを指定できますが、ASSOCF_INIT 値は 1 つしか含められません。
str	ASSOCSTR	in	返される文字列の種類を指定する ASSOCSTR 値です。
hkAssoc	HKEY	in	ルートキーとして使用するキーの HKEY 値です。検索はこのキーの下のみを対象とします。
pszExtra	LPCSTR	inoptional	文字列の場所に関する追加情報を含む、省略可能な null 終端文字列へのポインターです。通常は open などのシェル動詞 (verb) を設定します。使用しない場合はこのパラメーターを NULL に設定します。
pszOut	LPSTR	outoptional	要求された文字列を返すために使用する null 終端文字列へのポインターです。必要なバッファーサイズを取得するには、このパラメーターを NULL に設定します。
pcchOut	DWORD*	inout	値へのポインターで、入力時には pszOut バッファー内の文字数を指定します。関数が返るときには、バッファーに格納された文字数を指します。 flags に ASSOCF_NOTRUNCATE フラグが設定されていて、pszOut に指定したバッファーが小さすぎる場合、関数は E_POINTER を返し、この値には必要なバッファーサイズが設定されます。 pszOut が NULL の場合、関数は S_FALSE を返し、pcchOut は必要なバッファーサイズを指します。

戻り値の型: HRESULT

公式ドキュメント

指定したキーを起点として、レジストリからファイル関連付けに関する文字列を検索して取得します。(ANSI)

戻り値

型: HRESULT

標準的な COM エラー値を返します。次のものを含みます:

エラー	意味
S_OK	成功しました。
E_POINTER	pszOut バッファーが小さすぎて文字列全体を保持できません。
S_FALSE	pszOut が NULL です。pcchOut に必要なバッファーサイズが格納されます。

解説(Remarks)

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

メモ

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

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

各言語での呼び出し定義

// SHLWAPI.dll  (ANSI / -A)
#include <windows.h>

HRESULT AssocQueryStringByKeyA(
    ASSOCF flags,
    ASSOCSTR str,
    HKEY hkAssoc,
    LPCSTR pszExtra,   // optional
    LPSTR pszOut,   // optional
    DWORD* pcchOut
);

[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int AssocQueryStringByKeyA(
    uint flags,   // ASSOCF
    int str,   // ASSOCSTR
    IntPtr hkAssoc,   // HKEY
    [MarshalAs(UnmanagedType.LPStr)] string pszExtra,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszOut,   // LPSTR optional, out
    ref uint pcchOut   // DWORD* in/out
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function AssocQueryStringByKeyA(
    flags As UInteger,   ' ASSOCF
    str As Integer,   ' ASSOCSTR
    hkAssoc As IntPtr,   ' HKEY
    <MarshalAs(UnmanagedType.LPStr)> pszExtra As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> pszOut As System.Text.StringBuilder,   ' LPSTR optional, out
    ByRef pcchOut As UInteger   ' DWORD* in/out
) As Integer
End Function

' flags : ASSOCF
' str : ASSOCSTR
' hkAssoc : HKEY
' pszExtra : LPCSTR optional
' pszOut : LPSTR optional, out
' pcchOut : DWORD* in/out
Declare PtrSafe Function AssocQueryStringByKeyA Lib "shlwapi" ( _
    ByVal flags As Long, _
    ByVal str As Long, _
    ByVal hkAssoc As LongPtr, _
    ByVal pszExtra As String, _
    ByVal pszOut As String, _
    ByRef pcchOut As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

AssocQueryStringByKeyA = ctypes.windll.shlwapi.AssocQueryStringByKeyA
AssocQueryStringByKeyA.restype = ctypes.c_int
AssocQueryStringByKeyA.argtypes = [
    wintypes.DWORD,  # flags : ASSOCF
    ctypes.c_int,  # str : ASSOCSTR
    wintypes.HANDLE,  # hkAssoc : HKEY
    wintypes.LPCSTR,  # pszExtra : LPCSTR optional
    wintypes.LPSTR,  # pszOut : LPSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchOut : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
AssocQueryStringByKeyA = Fiddle::Function.new(
  lib['AssocQueryStringByKeyA'],
  [
    -Fiddle::TYPE_INT,  # flags : ASSOCF
    Fiddle::TYPE_INT,  # str : ASSOCSTR
    Fiddle::TYPE_VOIDP,  # hkAssoc : HKEY
    Fiddle::TYPE_VOIDP,  # pszExtra : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # pszOut : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchOut : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "shlwapi")]
extern "system" {
    fn AssocQueryStringByKeyA(
        flags: u32,  // ASSOCF
        str: i32,  // ASSOCSTR
        hkAssoc: *mut core::ffi::c_void,  // HKEY
        pszExtra: *const u8,  // LPCSTR optional
        pszOut: *mut u8,  // LPSTR optional, out
        pcchOut: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi)]
public static extern int AssocQueryStringByKeyA(uint flags, int str, IntPtr hkAssoc, [MarshalAs(UnmanagedType.LPStr)] string pszExtra, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszOut, ref uint pcchOut);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_AssocQueryStringByKeyA' -Namespace Win32 -PassThru
# $api::AssocQueryStringByKeyA(flags, str, hkAssoc, pszExtra, pszOut, pcchOut)

#uselib "SHLWAPI.dll"
#func global AssocQueryStringByKeyA "AssocQueryStringByKeyA" sptr, sptr, sptr, sptr, sptr, sptr
; AssocQueryStringByKeyA flags, str, hkAssoc, pszExtra, varptr(pszOut), varptr(pcchOut)   ; 戻り値は stat
; flags : ASSOCF -> "sptr"
; str : ASSOCSTR -> "sptr"
; hkAssoc : HKEY -> "sptr"
; pszExtra : LPCSTR optional -> "sptr"
; pszOut : LPSTR optional, out -> "sptr"
; pcchOut : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHLWAPI.dll"
#cfunc global AssocQueryStringByKeyA "AssocQueryStringByKeyA" int, int, sptr, str, var, var
; res = AssocQueryStringByKeyA(flags, str, hkAssoc, pszExtra, pszOut, pcchOut)
; flags : ASSOCF -> "int"
; str : ASSOCSTR -> "int"
; hkAssoc : HKEY -> "sptr"
; pszExtra : LPCSTR optional -> "str"
; pszOut : LPSTR optional, out -> "var"
; pcchOut : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHLWAPI.dll"
#cfunc global AssocQueryStringByKeyA "AssocQueryStringByKeyA" int, int, sptr, str, sptr, sptr
; res = AssocQueryStringByKeyA(flags, str, hkAssoc, pszExtra, varptr(pszOut), varptr(pcchOut))
; flags : ASSOCF -> "int"
; str : ASSOCSTR -> "int"
; hkAssoc : HKEY -> "sptr"
; pszExtra : LPCSTR optional -> "str"
; pszOut : LPSTR optional, out -> "sptr"
; pcchOut : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。