ホーム › UI.Shell › AssocQueryStringA

AssocQueryStringA

関数

ファイル関連付けに関する文字列情報を取得する。

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

シグネチャ

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

HRESULT AssocQueryStringA(
    ASSOCF flags,
    ASSOCSTR str,
    LPCSTR pszAssoc,
    LPCSTR pszExtra,   // optional
    LPSTR pszOut,   // optional
    DWORD* pcchOut
);

パラメーター

名前	型	方向	説明
flags	ASSOCF	in	検索を制御するために使用できるフラグです。ASSOCF 値の任意の組み合わせを指定できますが、ASSOCF_INIT 値は 1 つだけしか含められません。
str	ASSOCSTR	in	返される文字列の種類を指定する ASSOCSTR 値です。
pszAssoc	LPCSTR	in	ルートキーを決定するために使用される、null 終端文字列へのポインターです。次の 4 種類の文字列を使用できます。ファイル名拡張子: .txt などのファイル名拡張子です。 CLSID: 標準的な "{GUID}" 形式の CLSID GUID です。 ProgID: Word.Document.8 などのアプリケーションの ProgID です。実行可能ファイル名: アプリケーションの .exe ファイルの名前です。flags に ASSOCF_OPEN_BYEXENAME フラグを設定する必要があります。
pszExtra	LPCSTR	inoptional	文字列の場所に関する追加情報を含む、省略可能な null 終端文字列です。通常は open などのシェル動詞を設定します。使用しない場合は、このパラメーターを NULL に設定してください。
pszOut	LPSTR	outoptional	この関数が正常に返ったときに、要求された文字列を受け取る null 終端文字列へのポインターです。必要なバッファーサイズを取得するには、このパラメーターを NULL に設定してください。
pcchOut	DWORD*	inout	関数を呼び出すときに pszOut バッファー内の文字数に設定される値へのポインターです。関数が正常に返ると、この値は実際にバッファーに格納された文字数に設定されます。 flags に ASSOCF_NOTRUNCATE フラグが設定されていて、pszOut で指定したバッファーが小さすぎる場合、関数は E_POINTER を返し、この値は必要なバッファーサイズに設定されます。 pszOut が NULL の場合、関数は S_FALSE を返し、pcchOut は必要なバッファーサイズ(文字数)を指します。

戻り値の型: HRESULT

公式ドキュメント

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

戻り値

型: HRESULT

次を含む標準的な COM エラー値を返します。

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

解説(Remarks)

この関数は IQueryAssociations インターフェイスのラッパーです。AssocQueryString 関数は、IQueryAssociations インターフェイスを使用するプロセスを簡素化することを目的としています。

項目が選択されると、ホストはその項目に対してどのプレビューハンドラー(があれば)が利用可能かを判断する必要があります。プレビューハンドラーは通常、ファイル名拡張子または ProgID に対して登録されますが、一部のプレビューハンドラーは特定のシェルフォルダー内の項目に対してのみインスタンス化されます(たとえば、MAPI プレビューハンドラーは MAPI シェルフォルダーから取得された任意の項目に関連付けられています)。したがって、ホストはどのプレビューハンドラーを使用するかを判断するために IQueryAssociations を使用する必要があります。ファイルおよびプロトコルの関連付け関数の動作に関する詳細については、IQueryAssociations を参照してください。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 AssocQueryStringA(
    ASSOCF flags,
    ASSOCSTR str,
    LPCSTR pszAssoc,
    LPCSTR pszExtra,   // optional
    LPSTR pszOut,   // optional
    DWORD* pcchOut
);

[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int AssocQueryStringA(
    uint flags,   // ASSOCF
    int str,   // ASSOCSTR
    [MarshalAs(UnmanagedType.LPStr)] string pszAssoc,   // LPCSTR
    [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 AssocQueryStringA(
    flags As UInteger,   ' ASSOCF
    str As Integer,   ' ASSOCSTR
    <MarshalAs(UnmanagedType.LPStr)> pszAssoc As String,   ' LPCSTR
    <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
' pszAssoc : LPCSTR
' pszExtra : LPCSTR optional
' pszOut : LPSTR optional, out
' pcchOut : DWORD* in/out
Declare PtrSafe Function AssocQueryStringA Lib "shlwapi" ( _
    ByVal flags As Long, _
    ByVal str As Long, _
    ByVal pszAssoc As String, _
    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

AssocQueryStringA = ctypes.windll.shlwapi.AssocQueryStringA
AssocQueryStringA.restype = ctypes.c_int
AssocQueryStringA.argtypes = [
    wintypes.DWORD,  # flags : ASSOCF
    ctypes.c_int,  # str : ASSOCSTR
    wintypes.LPCSTR,  # pszAssoc : LPCSTR
    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')
AssocQueryStringA = Fiddle::Function.new(
  lib['AssocQueryStringA'],
  [
    -Fiddle::TYPE_INT,  # flags : ASSOCF
    Fiddle::TYPE_INT,  # str : ASSOCSTR
    Fiddle::TYPE_VOIDP,  # pszAssoc : LPCSTR
    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 AssocQueryStringA(
        flags: u32,  // ASSOCF
        str: i32,  // ASSOCSTR
        pszAssoc: *const u8,  // LPCSTR
        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 AssocQueryStringA(uint flags, int str, [MarshalAs(UnmanagedType.LPStr)] string pszAssoc, [MarshalAs(UnmanagedType.LPStr)] string pszExtra, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszOut, ref uint pcchOut);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_AssocQueryStringA' -Namespace Win32 -PassThru
# $api::AssocQueryStringA(flags, str, pszAssoc, pszExtra, pszOut, pcchOut)

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

出力引数:

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