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

PathIsSystemFolderW

関数
指定したフォルダがシステムフォルダかどうかを判定する。
DLLSHLWAPI.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// SHLWAPI.dll  (Unicode / -W)
#include <windows.h>

BOOL PathIsSystemFolderW(
    LPCWSTR pszPath,   // optional
    DWORD dwAttrb
);

パラメーター

名前方向説明
pszPathLPCWSTRinoptional既存のフォルダーの名前を含む、最大長 MAX_PATH の null 終端文字列へのポインターです。このフォルダーの属性が取得され、システムフォルダーを定義する属性と比較されます。このフォルダーがシステムフォルダーとなる属性を備えている場合、関数は 0 以外を返します。この値が NULL の場合、この関数は dwAttrb に渡された属性がシステムフォルダーとして認定されるかどうかを判定します。
dwAttrbDWORDin比較対象となるファイル属性です。pszPathNULL の場合にのみ使用されます。その場合、この値に渡された属性が、フォルダーをシステムフォルダーとして認定する属性と比較されます。属性がシステムフォルダーとするのに十分であれば、この関数は 0 以外を返します。これらの属性は GetFileAttributes から返される属性です。

戻り値の型: BOOL

公式ドキュメント

既存のフォルダーがシステムフォルダーとしての属性を備えているかどうかを判定します。あるいは、この関数は特定の属性によってフォルダーがシステムフォルダーとして認定されるかどうかを示します。(Unicode)

戻り値

型: BOOL

pszPath または dwAttrb がシステムフォルダーを表す場合は 0 以外を返し、それ以外の場合は 0 を返します。

解説(Remarks)

メモ

shlwapi.h ヘッダーは、PathIsSystemFolder を、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  (Unicode / -W)
#include <windows.h>

BOOL PathIsSystemFolderW(
    LPCWSTR pszPath,   // optional
    DWORD dwAttrb
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool PathIsSystemFolderW(
    [MarshalAs(UnmanagedType.LPWStr)] string pszPath,   // LPCWSTR optional
    uint dwAttrb   // DWORD
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function PathIsSystemFolderW(
    <MarshalAs(UnmanagedType.LPWStr)> pszPath As String,   ' LPCWSTR optional
    dwAttrb As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pszPath : LPCWSTR optional
' dwAttrb : DWORD
Declare PtrSafe Function PathIsSystemFolderW Lib "shlwapi" ( _
    ByVal pszPath As LongPtr, _
    ByVal dwAttrb As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PathIsSystemFolderW = ctypes.windll.shlwapi.PathIsSystemFolderW
PathIsSystemFolderW.restype = wintypes.BOOL
PathIsSystemFolderW.argtypes = [
    wintypes.LPCWSTR,  # pszPath : LPCWSTR optional
    wintypes.DWORD,  # dwAttrb : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
PathIsSystemFolderW = Fiddle::Function.new(
  lib['PathIsSystemFolderW'],
  [
    Fiddle::TYPE_VOIDP,  # pszPath : LPCWSTR optional
    -Fiddle::TYPE_INT,  # dwAttrb : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "shlwapi")]
extern "system" {
    fn PathIsSystemFolderW(
        pszPath: *const u16,  // LPCWSTR 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.Unicode)]
public static extern bool PathIsSystemFolderW([MarshalAs(UnmanagedType.LPWStr)] string pszPath, uint dwAttrb);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_PathIsSystemFolderW' -Namespace Win32 -PassThru
# $api::PathIsSystemFolderW(pszPath, dwAttrb)
#uselib "SHLWAPI.dll"
#func global PathIsSystemFolderW "PathIsSystemFolderW" wptr, wptr
; PathIsSystemFolderW pszPath, dwAttrb   ; 戻り値は stat
; pszPath : LPCWSTR optional -> "wptr"
; dwAttrb : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SHLWAPI.dll"
#cfunc global PathIsSystemFolderW "PathIsSystemFolderW" wstr, int
; res = PathIsSystemFolderW(pszPath, dwAttrb)
; pszPath : LPCWSTR optional -> "wstr"
; dwAttrb : DWORD -> "int"
; BOOL PathIsSystemFolderW(LPCWSTR pszPath, DWORD dwAttrb)
#uselib "SHLWAPI.dll"
#cfunc global PathIsSystemFolderW "PathIsSystemFolderW" wstr, int
; res = PathIsSystemFolderW(pszPath, dwAttrb)
; pszPath : LPCWSTR optional -> "wstr"
; dwAttrb : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procPathIsSystemFolderW = shlwapi.NewProc("PathIsSystemFolderW")
)

// pszPath (LPCWSTR optional), dwAttrb (DWORD)
r1, _, err := procPathIsSystemFolderW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszPath))),
	uintptr(dwAttrb),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function PathIsSystemFolderW(
  pszPath: PWideChar;   // LPCWSTR optional
  dwAttrb: DWORD   // DWORD
): BOOL; stdcall;
  external 'SHLWAPI.dll' name 'PathIsSystemFolderW';
result := DllCall("SHLWAPI\PathIsSystemFolderW"
    , "WStr", pszPath   ; LPCWSTR optional
    , "UInt", dwAttrb   ; DWORD
    , "Int")   ; return: BOOL
●PathIsSystemFolderW(pszPath, dwAttrb) = DLL("SHLWAPI.dll", "bool PathIsSystemFolderW(char*, dword)")
# 呼び出し: PathIsSystemFolderW(pszPath, dwAttrb)
# pszPath : LPCWSTR optional -> "char*"
# dwAttrb : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "shlwapi" fn PathIsSystemFolderW(
    pszPath: [*c]const u16, // LPCWSTR optional
    dwAttrb: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc PathIsSystemFolderW(
    pszPath: WideCString,  # LPCWSTR optional
    dwAttrb: uint32  # DWORD
): int32 {.importc: "PathIsSystemFolderW", stdcall, dynlib: "SHLWAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "shlwapi");
extern(Windows)
int PathIsSystemFolderW(
    const(wchar)* pszPath,   // LPCWSTR optional
    uint dwAttrb   // DWORD
);
ccall((:PathIsSystemFolderW, "SHLWAPI.dll"), stdcall, Int32,
      (Cwstring, UInt32),
      pszPath, dwAttrb)
# pszPath : LPCWSTR optional -> Cwstring
# dwAttrb : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t PathIsSystemFolderW(
    const uint16_t* pszPath,
    uint32_t dwAttrb);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.PathIsSystemFolderW(pszPath, dwAttrb)
-- pszPath : LPCWSTR optional
-- dwAttrb : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const PathIsSystemFolderW = lib.func('__stdcall', 'PathIsSystemFolderW', 'int32_t', ['str16', 'uint32_t']);
// PathIsSystemFolderW(pszPath, dwAttrb)
// pszPath : LPCWSTR optional -> 'str16'
// dwAttrb : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  PathIsSystemFolderW: { parameters: ["buffer", "u32"], result: "i32" },
});
// lib.symbols.PathIsSystemFolderW(pszPath, dwAttrb)
// pszPath : LPCWSTR optional -> "buffer"
// dwAttrb : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t PathIsSystemFolderW(
    const uint16_t* pszPath,
    uint32_t dwAttrb);
C, "SHLWAPI.dll");
// $ffi->PathIsSystemFolderW(pszPath, dwAttrb);
// pszPath : LPCWSTR 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.UNICODE_OPTIONS);
    boolean PathIsSystemFolderW(
        WString pszPath,   // LPCWSTR optional
        int dwAttrb   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("shlwapi")]
lib LibSHLWAPI
  fun PathIsSystemFolderW = PathIsSystemFolderW(
    pszPath : UInt16*,   # LPCWSTR 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 PathIsSystemFolderWNative = Int32 Function(Pointer<Utf16>, Uint32);
typedef PathIsSystemFolderWDart = int Function(Pointer<Utf16>, int);
final PathIsSystemFolderW = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<PathIsSystemFolderWNative, PathIsSystemFolderWDart>('PathIsSystemFolderW');
// pszPath : LPCWSTR optional -> Pointer<Utf16>
// dwAttrb : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PathIsSystemFolderW(
  pszPath: PWideChar;   // LPCWSTR optional
  dwAttrb: DWORD   // DWORD
): BOOL; stdcall;
  external 'SHLWAPI.dll' name 'PathIsSystemFolderW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PathIsSystemFolderW"
  c_PathIsSystemFolderW :: CWString -> Word32 -> IO CInt
-- pszPath : LPCWSTR optional -> CWString
-- dwAttrb : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let pathissystemfolderw =
  foreign "PathIsSystemFolderW"
    ((ptr uint16_t) @-> uint32_t @-> returning int32_t)
(* pszPath : LPCWSTR optional -> (ptr uint16_t) *)
(* 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 ("PathIsSystemFolderW" path-is-system-folder-w :convention :stdcall) :int32
  (psz-path (:string :encoding :utf-16le))   ; LPCWSTR optional
  (dw-attrb :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PathIsSystemFolderW = Win32::API::More->new('SHLWAPI',
    'BOOL PathIsSystemFolderW(LPCWSTR pszPath, DWORD dwAttrb)');
# my $ret = $PathIsSystemFolderW->Call($pszPath, $dwAttrb);
# pszPath : LPCWSTR optional -> LPCWSTR
# dwAttrb : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い