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

PathSearchAndQualifyA

関数
パスを検索して完全修飾された絶対パスに変換する。
DLLSHLWAPI.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL PathSearchAndQualifyA(
    LPCSTR pszPath,
    LPSTR pszBuf,
    DWORD cchBuf
);

パラメーター

名前方向説明
pszPathLPCSTRin検索対象のパスを格納した、最大長 MAX_PATH の null 終端文字列へのポインター。
pszBufLPSTRout参照されるパスを格納する、長さ MAX_PATH の null 終端文字列へのポインター。
cchBufDWORDinpszFullyQualifiedPath が指すバッファーのサイズ(文字数単位)。

戻り値の型: BOOL

公式ドキュメント

指定されたパスが正しい形式であり、完全修飾されているかどうかを判定します。(ANSI)

戻り値

型: BOOL

パスが修飾されている場合は TRUE を、それ以外の場合は FALSE を返します。

解説(Remarks)

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

BOOL PathSearchAndQualifyA(
    LPCSTR pszPath,
    LPSTR pszBuf,
    DWORD cchBuf
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool PathSearchAndQualifyA(
    [MarshalAs(UnmanagedType.LPStr)] string pszPath,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszBuf,   // LPSTR out
    uint cchBuf   // DWORD
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function PathSearchAndQualifyA(
    <MarshalAs(UnmanagedType.LPStr)> pszPath As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> pszBuf As System.Text.StringBuilder,   ' LPSTR out
    cchBuf As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pszPath : LPCSTR
' pszBuf : LPSTR out
' cchBuf : DWORD
Declare PtrSafe Function PathSearchAndQualifyA Lib "shlwapi" ( _
    ByVal pszPath As String, _
    ByVal pszBuf As String, _
    ByVal cchBuf As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PathSearchAndQualifyA = ctypes.windll.shlwapi.PathSearchAndQualifyA
PathSearchAndQualifyA.restype = wintypes.BOOL
PathSearchAndQualifyA.argtypes = [
    wintypes.LPCSTR,  # pszPath : LPCSTR
    wintypes.LPSTR,  # pszBuf : LPSTR out
    wintypes.DWORD,  # cchBuf : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
PathSearchAndQualifyA = Fiddle::Function.new(
  lib['PathSearchAndQualifyA'],
  [
    Fiddle::TYPE_VOIDP,  # pszPath : LPCSTR
    Fiddle::TYPE_VOIDP,  # pszBuf : LPSTR out
    -Fiddle::TYPE_INT,  # cchBuf : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "shlwapi")]
extern "system" {
    fn PathSearchAndQualifyA(
        pszPath: *const u8,  // LPCSTR
        pszBuf: *mut u8,  // LPSTR out
        cchBuf: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi)]
public static extern bool PathSearchAndQualifyA([MarshalAs(UnmanagedType.LPStr)] string pszPath, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszBuf, uint cchBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_PathSearchAndQualifyA' -Namespace Win32 -PassThru
# $api::PathSearchAndQualifyA(pszPath, pszBuf, cchBuf)
#uselib "SHLWAPI.dll"
#func global PathSearchAndQualifyA "PathSearchAndQualifyA" sptr, sptr, sptr
; PathSearchAndQualifyA pszPath, varptr(pszBuf), cchBuf   ; 戻り値は stat
; pszPath : LPCSTR -> "sptr"
; pszBuf : LPSTR out -> "sptr"
; cchBuf : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHLWAPI.dll"
#cfunc global PathSearchAndQualifyA "PathSearchAndQualifyA" str, var, int
; res = PathSearchAndQualifyA(pszPath, pszBuf, cchBuf)
; pszPath : LPCSTR -> "str"
; pszBuf : LPSTR out -> "var"
; cchBuf : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL PathSearchAndQualifyA(LPCSTR pszPath, LPSTR pszBuf, DWORD cchBuf)
#uselib "SHLWAPI.dll"
#cfunc global PathSearchAndQualifyA "PathSearchAndQualifyA" str, var, int
; res = PathSearchAndQualifyA(pszPath, pszBuf, cchBuf)
; pszPath : LPCSTR -> "str"
; pszBuf : LPSTR out -> "var"
; cchBuf : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procPathSearchAndQualifyA = shlwapi.NewProc("PathSearchAndQualifyA")
)

// pszPath (LPCSTR), pszBuf (LPSTR out), cchBuf (DWORD)
r1, _, err := procPathSearchAndQualifyA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pszPath))),
	uintptr(pszBuf),
	uintptr(cchBuf),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function PathSearchAndQualifyA(
  pszPath: PAnsiChar;   // LPCSTR
  pszBuf: PAnsiChar;   // LPSTR out
  cchBuf: DWORD   // DWORD
): BOOL; stdcall;
  external 'SHLWAPI.dll' name 'PathSearchAndQualifyA';
result := DllCall("SHLWAPI\PathSearchAndQualifyA"
    , "AStr", pszPath   ; LPCSTR
    , "Ptr", pszBuf   ; LPSTR out
    , "UInt", cchBuf   ; DWORD
    , "Int")   ; return: BOOL
●PathSearchAndQualifyA(pszPath, pszBuf, cchBuf) = DLL("SHLWAPI.dll", "bool PathSearchAndQualifyA(char*, char*, dword)")
# 呼び出し: PathSearchAndQualifyA(pszPath, pszBuf, cchBuf)
# pszPath : LPCSTR -> "char*"
# pszBuf : LPSTR out -> "char*"
# cchBuf : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "shlwapi" fn PathSearchAndQualifyA(
    pszPath: [*c]const u8, // LPCSTR
    pszBuf: [*c]u8, // LPSTR out
    cchBuf: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc PathSearchAndQualifyA(
    pszPath: cstring,  # LPCSTR
    pszBuf: ptr char,  # LPSTR out
    cchBuf: uint32  # DWORD
): int32 {.importc: "PathSearchAndQualifyA", stdcall, dynlib: "SHLWAPI.dll".}
pragma(lib, "shlwapi");
extern(Windows)
int PathSearchAndQualifyA(
    const(char)* pszPath,   // LPCSTR
    char* pszBuf,   // LPSTR out
    uint cchBuf   // DWORD
);
ccall((:PathSearchAndQualifyA, "SHLWAPI.dll"), stdcall, Int32,
      (Cstring, Ptr{UInt8}, UInt32),
      pszPath, pszBuf, cchBuf)
# pszPath : LPCSTR -> Cstring
# pszBuf : LPSTR out -> Ptr{UInt8}
# cchBuf : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t PathSearchAndQualifyA(
    const char* pszPath,
    char* pszBuf,
    uint32_t cchBuf);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.PathSearchAndQualifyA(pszPath, pszBuf, cchBuf)
-- pszPath : LPCSTR
-- pszBuf : LPSTR out
-- cchBuf : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const PathSearchAndQualifyA = lib.func('__stdcall', 'PathSearchAndQualifyA', 'int32_t', ['str', 'char *', 'uint32_t']);
// PathSearchAndQualifyA(pszPath, pszBuf, cchBuf)
// pszPath : LPCSTR -> 'str'
// pszBuf : LPSTR out -> 'char *'
// cchBuf : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  PathSearchAndQualifyA: { parameters: ["buffer", "buffer", "u32"], result: "i32" },
});
// lib.symbols.PathSearchAndQualifyA(pszPath, pszBuf, cchBuf)
// pszPath : LPCSTR -> "buffer"
// pszBuf : LPSTR out -> "buffer"
// cchBuf : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t PathSearchAndQualifyA(
    const char* pszPath,
    char* pszBuf,
    uint32_t cchBuf);
C, "SHLWAPI.dll");
// $ffi->PathSearchAndQualifyA(pszPath, pszBuf, cchBuf);
// pszPath : LPCSTR
// pszBuf : LPSTR out
// cchBuf : DWORD
// 構造体/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.ASCII_OPTIONS);
    boolean PathSearchAndQualifyA(
        String pszPath,   // LPCSTR
        byte[] pszBuf,   // LPSTR out
        int cchBuf   // DWORD
    );
}
@[Link("shlwapi")]
lib LibSHLWAPI
  fun PathSearchAndQualifyA = PathSearchAndQualifyA(
    pszPath : UInt8*,   # LPCSTR
    pszBuf : UInt8*,   # LPSTR out
    cchBuf : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef PathSearchAndQualifyANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>, Uint32);
typedef PathSearchAndQualifyADart = int Function(Pointer<Utf8>, Pointer<Utf8>, int);
final PathSearchAndQualifyA = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<PathSearchAndQualifyANative, PathSearchAndQualifyADart>('PathSearchAndQualifyA');
// pszPath : LPCSTR -> Pointer<Utf8>
// pszBuf : LPSTR out -> Pointer<Utf8>
// cchBuf : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PathSearchAndQualifyA(
  pszPath: PAnsiChar;   // LPCSTR
  pszBuf: PAnsiChar;   // LPSTR out
  cchBuf: DWORD   // DWORD
): BOOL; stdcall;
  external 'SHLWAPI.dll' name 'PathSearchAndQualifyA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PathSearchAndQualifyA"
  c_PathSearchAndQualifyA :: CString -> CString -> Word32 -> IO CInt
-- pszPath : LPCSTR -> CString
-- pszBuf : LPSTR out -> CString
-- cchBuf : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let pathsearchandqualifya =
  foreign "PathSearchAndQualifyA"
    (string @-> string @-> uint32_t @-> returning int32_t)
(* pszPath : LPCSTR -> string *)
(* pszBuf : LPSTR out -> string *)
(* cchBuf : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("PathSearchAndQualifyA" path-search-and-qualify-a :convention :stdcall) :int32
  (psz-path :string)   ; LPCSTR
  (psz-buf :pointer)   ; LPSTR out
  (cch-buf :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PathSearchAndQualifyA = Win32::API::More->new('SHLWAPI',
    'BOOL PathSearchAndQualifyA(LPCSTR pszPath, LPSTR pszBuf, DWORD cchBuf)');
# my $ret = $PathSearchAndQualifyA->Call($pszPath, $pszBuf, $cchBuf);
# pszPath : LPCSTR -> LPCSTR
# pszBuf : LPSTR out -> LPSTR
# cchBuf : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い