PathIsSystemFolderA
関数指定したフォルダがシステムフォルダかどうかを判定する。
シグネチャ
// SHLWAPI.dll (ANSI / -A)
#include <windows.h>
BOOL PathIsSystemFolderA(
LPCSTR pszPath, // optional
DWORD dwAttrb
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| pszPath | LPCSTR | inoptional | 既存のフォルダー名を含む、最大長 MAX_PATH の null 終端文字列へのポインター。このフォルダーの属性が取得され、システムフォルダーを定義する属性と比較されます。このフォルダーがシステムフォルダーとなる属性を持つ場合、この関数は 0 以外を返します。この値が NULL の場合、この関数は dwAttrb で渡された属性がシステムフォルダーとして適格かどうかを判定します。 |
| dwAttrb | DWORD | in | 比較対象のファイル属性。pszPath が NULL の場合にのみ使用されます。その場合、この値で渡された属性が、フォルダーをシステムフォルダーとして適格とする属性と比較されます。属性がシステムフォルダーとするのに十分であれば、この関数は 0 以外を返します。これらの属性は、GetFileAttributes から返される属性です。 |
戻り値の型: BOOL
公式ドキュメント
既存のフォルダーが、それをシステムフォルダーにする属性を持つかどうかを判定します。あるいは、特定の属性がフォルダーをシステムフォルダーとするのに適格かどうかを示します。(ANSI)
戻り値
型: BOOL
pszPath または dwAttrb がシステムフォルダーを表す場合は 0 以外を、そうでない場合は 0 を返します。
解説(Remarks)
メモ
shlwapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして PathIsSystemFolder を定義しています。エンコーディング中立なエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不一致につながる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// SHLWAPI.dll (ANSI / -A)
#include <windows.h>
BOOL PathIsSystemFolderA(
LPCSTR pszPath, // optional
DWORD dwAttrb
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool PathIsSystemFolderA(
[MarshalAs(UnmanagedType.LPStr)] string pszPath, // LPCSTR optional
uint dwAttrb // DWORD
);<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function PathIsSystemFolderA(
<MarshalAs(UnmanagedType.LPStr)> pszPath As String, ' LPCSTR optional
dwAttrb As UInteger ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' pszPath : LPCSTR optional
' dwAttrb : DWORD
Declare PtrSafe Function PathIsSystemFolderA Lib "shlwapi" ( _
ByVal pszPath As String, _
ByVal dwAttrb As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
PathIsSystemFolderA = ctypes.windll.shlwapi.PathIsSystemFolderA
PathIsSystemFolderA.restype = wintypes.BOOL
PathIsSystemFolderA.argtypes = [
wintypes.LPCSTR, # pszPath : LPCSTR optional
wintypes.DWORD, # dwAttrb : DWORD
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('SHLWAPI.dll')
PathIsSystemFolderA = Fiddle::Function.new(
lib['PathIsSystemFolderA'],
[
Fiddle::TYPE_VOIDP, # pszPath : LPCSTR optional
-Fiddle::TYPE_INT, # dwAttrb : DWORD
],
Fiddle::TYPE_INT)#[link(name = "shlwapi")]
extern "system" {
fn PathIsSystemFolderA(
pszPath: *const u8, // LPCSTR optional
dwAttrb: 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 PathIsSystemFolderA([MarshalAs(UnmanagedType.LPStr)] string pszPath, uint dwAttrb);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_PathIsSystemFolderA' -Namespace Win32 -PassThru
# $api::PathIsSystemFolderA(pszPath, dwAttrb)#uselib "SHLWAPI.dll"
#func global PathIsSystemFolderA "PathIsSystemFolderA" sptr, sptr
; PathIsSystemFolderA pszPath, dwAttrb ; 戻り値は stat
; pszPath : LPCSTR optional -> "sptr"
; dwAttrb : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "SHLWAPI.dll"
#cfunc global PathIsSystemFolderA "PathIsSystemFolderA" str, int
; res = PathIsSystemFolderA(pszPath, dwAttrb)
; pszPath : LPCSTR optional -> "str"
; dwAttrb : DWORD -> "int"; BOOL PathIsSystemFolderA(LPCSTR pszPath, DWORD dwAttrb)
#uselib "SHLWAPI.dll"
#cfunc global PathIsSystemFolderA "PathIsSystemFolderA" str, int
; res = PathIsSystemFolderA(pszPath, dwAttrb)
; pszPath : LPCSTR optional -> "str"
; dwAttrb : DWORD -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
procPathIsSystemFolderA = shlwapi.NewProc("PathIsSystemFolderA")
)
// pszPath (LPCSTR optional), dwAttrb (DWORD)
r1, _, err := procPathIsSystemFolderA.Call(
uintptr(unsafe.Pointer(windows.BytePtrFromString(pszPath))),
uintptr(dwAttrb),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction PathIsSystemFolderA(
pszPath: PAnsiChar; // LPCSTR optional
dwAttrb: DWORD // DWORD
): BOOL; stdcall;
external 'SHLWAPI.dll' name 'PathIsSystemFolderA';result := DllCall("SHLWAPI\PathIsSystemFolderA"
, "AStr", pszPath ; LPCSTR optional
, "UInt", dwAttrb ; DWORD
, "Int") ; return: BOOL●PathIsSystemFolderA(pszPath, dwAttrb) = DLL("SHLWAPI.dll", "bool PathIsSystemFolderA(char*, dword)")
# 呼び出し: PathIsSystemFolderA(pszPath, dwAttrb)
# pszPath : LPCSTR optional -> "char*"
# dwAttrb : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "shlwapi" fn PathIsSystemFolderA(
pszPath: [*c]const u8, // LPCSTR optional
dwAttrb: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;proc PathIsSystemFolderA(
pszPath: cstring, # LPCSTR optional
dwAttrb: uint32 # DWORD
): int32 {.importc: "PathIsSystemFolderA", stdcall, dynlib: "SHLWAPI.dll".}pragma(lib, "shlwapi");
extern(Windows)
int PathIsSystemFolderA(
const(char)* pszPath, // LPCSTR optional
uint dwAttrb // DWORD
);ccall((:PathIsSystemFolderA, "SHLWAPI.dll"), stdcall, Int32,
(Cstring, UInt32),
pszPath, dwAttrb)
# pszPath : LPCSTR optional -> Cstring
# dwAttrb : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t PathIsSystemFolderA(
const char* pszPath,
uint32_t dwAttrb);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.PathIsSystemFolderA(pszPath, dwAttrb)
-- pszPath : LPCSTR optional
-- dwAttrb : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const PathIsSystemFolderA = lib.func('__stdcall', 'PathIsSystemFolderA', 'int32_t', ['str', 'uint32_t']);
// PathIsSystemFolderA(pszPath, dwAttrb)
// pszPath : LPCSTR optional -> 'str'
// dwAttrb : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHLWAPI.dll", {
PathIsSystemFolderA: { parameters: ["buffer", "u32"], result: "i32" },
});
// lib.symbols.PathIsSystemFolderA(pszPath, dwAttrb)
// pszPath : LPCSTR optional -> "buffer"
// dwAttrb : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t PathIsSystemFolderA(
const char* pszPath,
uint32_t dwAttrb);
C, "SHLWAPI.dll");
// $ffi->PathIsSystemFolderA(pszPath, dwAttrb);
// pszPath : LPCSTR optional
// dwAttrb : 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 PathIsSystemFolderA(
String pszPath, // LPCSTR optional
int dwAttrb // DWORD
);
}@[Link("shlwapi")]
lib LibSHLWAPI
fun PathIsSystemFolderA = PathIsSystemFolderA(
pszPath : UInt8*, # LPCSTR optional
dwAttrb : 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 PathIsSystemFolderANative = Int32 Function(Pointer<Utf8>, Uint32);
typedef PathIsSystemFolderADart = int Function(Pointer<Utf8>, int);
final PathIsSystemFolderA = DynamicLibrary.open('SHLWAPI.dll')
.lookupFunction<PathIsSystemFolderANative, PathIsSystemFolderADart>('PathIsSystemFolderA');
// pszPath : LPCSTR optional -> Pointer<Utf8>
// dwAttrb : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function PathIsSystemFolderA(
pszPath: PAnsiChar; // LPCSTR optional
dwAttrb: DWORD // DWORD
): BOOL; stdcall;
external 'SHLWAPI.dll' name 'PathIsSystemFolderA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "PathIsSystemFolderA"
c_PathIsSystemFolderA :: CString -> Word32 -> IO CInt
-- pszPath : LPCSTR optional -> CString
-- dwAttrb : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let pathissystemfoldera =
foreign "PathIsSystemFolderA"
(string @-> uint32_t @-> returning int32_t)
(* pszPath : LPCSTR optional -> string *)
(* dwAttrb : 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 ("PathIsSystemFolderA" path-is-system-folder-a :convention :stdcall) :int32
(psz-path :string) ; LPCSTR optional
(dw-attrb :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $PathIsSystemFolderA = Win32::API::More->new('SHLWAPI',
'BOOL PathIsSystemFolderA(LPCSTR pszPath, DWORD dwAttrb)');
# my $ret = $PathIsSystemFolderA->Call($pszPath, $dwAttrb);
# pszPath : LPCSTR optional -> LPCSTR
# dwAttrb : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
文字セット違い
- f PathIsSystemFolderW (Unicode版) — 指定したフォルダがシステムフォルダかどうかを判定する。