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

PathQuoteSpacesA

関数
空白を含むパスを二重引用符で囲む。
DLLSHLWAPI.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL PathQuoteSpacesA(
    LPSTR lpsz
);

パラメーター

名前方向説明
lpszLPSTRinout検索対象のパスを格納した、null で終わる文字列へのポインター。このバッファーのサイズは、返される文字列を確実に格納できるよう MAX_PATH に設定する必要があります。

戻り値の型: BOOL

公式ドキュメント

パスを検索してスペースの有無を調べます。スペースが見つかった場合は、パス全体を引用符で囲みます。(ANSI)

戻り値

型: BOOL

スペースが見つかった場合は TRUE、それ以外の場合は FALSE

解説(Remarks)

メモ

shlwapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして PathQuoteSpaces を定義します。エンコーディング非依存のエイリアスを、エンコーディング非依存ではないコードと混在して使用すると、不一致が生じ、コンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、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 PathQuoteSpacesA(
    LPSTR lpsz
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool PathQuoteSpacesA(
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpsz   // LPSTR in/out
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function PathQuoteSpacesA(
    <MarshalAs(UnmanagedType.LPStr)> lpsz As System.Text.StringBuilder   ' LPSTR in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpsz : LPSTR in/out
Declare PtrSafe Function PathQuoteSpacesA Lib "shlwapi" ( _
    ByVal lpsz As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PathQuoteSpacesA = ctypes.windll.shlwapi.PathQuoteSpacesA
PathQuoteSpacesA.restype = wintypes.BOOL
PathQuoteSpacesA.argtypes = [
    wintypes.LPSTR,  # lpsz : LPSTR in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
PathQuoteSpacesA = Fiddle::Function.new(
  lib['PathQuoteSpacesA'],
  [
    Fiddle::TYPE_VOIDP,  # lpsz : LPSTR in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "shlwapi")]
extern "system" {
    fn PathQuoteSpacesA(
        lpsz: *mut u8  // LPSTR in/out
    ) -> 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 PathQuoteSpacesA([MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpsz);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_PathQuoteSpacesA' -Namespace Win32 -PassThru
# $api::PathQuoteSpacesA(lpsz)
#uselib "SHLWAPI.dll"
#func global PathQuoteSpacesA "PathQuoteSpacesA" sptr
; PathQuoteSpacesA varptr(lpsz)   ; 戻り値は stat
; lpsz : LPSTR in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHLWAPI.dll"
#cfunc global PathQuoteSpacesA "PathQuoteSpacesA" var
; res = PathQuoteSpacesA(lpsz)
; lpsz : LPSTR in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL PathQuoteSpacesA(LPSTR lpsz)
#uselib "SHLWAPI.dll"
#cfunc global PathQuoteSpacesA "PathQuoteSpacesA" var
; res = PathQuoteSpacesA(lpsz)
; lpsz : LPSTR in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procPathQuoteSpacesA = shlwapi.NewProc("PathQuoteSpacesA")
)

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

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

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

foreign import stdcall safe "PathQuoteSpacesA"
  c_PathQuoteSpacesA :: CString -> IO CInt
-- lpsz : LPSTR in/out -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let pathquotespacesa =
  foreign "PathQuoteSpacesA"
    (string @-> returning int32_t)
(* lpsz : LPSTR in/out -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("PathQuoteSpacesA" path-quote-spaces-a :convention :stdcall) :int32
  (lpsz :pointer))   ; LPSTR in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PathQuoteSpacesA = Win32::API::More->new('SHLWAPI',
    'BOOL PathQuoteSpacesA(LPSTR lpsz)');
# my $ret = $PathQuoteSpacesA->Call($lpsz);
# lpsz : LPSTR in/out -> LPSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い