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

PathGetCharTypeW

関数
パス中の1文字が持つ意味の種類を示すフラグを取得する。
DLLSHLWAPI.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD PathGetCharTypeW(
    WCHAR ch
);

パラメーター

名前方向説明
chWCHARin種類を判定する対象の文字。

戻り値の型: DWORD

公式ドキュメント

パスとの関係において文字の種類を判定します。(Unicode)

戻り値

型: UINT

文字の種類を定義する次の値のうち、1 つ以上を返します。

戻り値 説明
GCT_INVALID
その文字はパスとして無効です。
GCT_LFNCHAR
その文字は長いファイル名で有効です。
GCT_SEPARATOR
その文字はパス区切り文字です。
GCT_SHORTCHAR
その文字は短い (8.3 形式) ファイル名で有効です。
GCT_WILD
その文字はワイルドカード文字です。

解説(Remarks)

メモ

shlwapi.h ヘッダーは PathGetCharType をエイリアスとして定義しており、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>

DWORD PathGetCharTypeW(
    WCHAR ch
);
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint PathGetCharTypeW(
    char ch   // WCHAR
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function PathGetCharTypeW(
    ch As Char   ' WCHAR
) As UInteger
End Function
' ch : WCHAR
Declare PtrSafe Function PathGetCharTypeW Lib "shlwapi" ( _
    ByVal ch As Integer) 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

PathGetCharTypeW = ctypes.windll.shlwapi.PathGetCharTypeW
PathGetCharTypeW.restype = wintypes.DWORD
PathGetCharTypeW.argtypes = [
    ctypes.c_wchar,  # ch : WCHAR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
PathGetCharTypeW = Fiddle::Function.new(
  lib['PathGetCharTypeW'],
  [
    Fiddle::TYPE_SHORT,  # ch : WCHAR
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "shlwapi")]
extern "system" {
    fn PathGetCharTypeW(
        ch: u16  // WCHAR
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode)]
public static extern uint PathGetCharTypeW(char ch);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_PathGetCharTypeW' -Namespace Win32 -PassThru
# $api::PathGetCharTypeW(ch)
#uselib "SHLWAPI.dll"
#func global PathGetCharTypeW "PathGetCharTypeW" wptr
; PathGetCharTypeW ch   ; 戻り値は stat
; ch : WCHAR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SHLWAPI.dll"
#cfunc global PathGetCharTypeW "PathGetCharTypeW" int
; res = PathGetCharTypeW(ch)
; ch : WCHAR -> "int"
; DWORD PathGetCharTypeW(WCHAR ch)
#uselib "SHLWAPI.dll"
#cfunc global PathGetCharTypeW "PathGetCharTypeW" int
; res = PathGetCharTypeW(ch)
; ch : WCHAR -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procPathGetCharTypeW = shlwapi.NewProc("PathGetCharTypeW")
)

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

extern "shlwapi" fn PathGetCharTypeW(
    ch: u16 // WCHAR
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc PathGetCharTypeW(
    ch: uint16  # WCHAR
): uint32 {.importc: "PathGetCharTypeW", stdcall, dynlib: "SHLWAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "shlwapi");
extern(Windows)
uint PathGetCharTypeW(
    wchar ch   // WCHAR
);
ccall((:PathGetCharTypeW, "SHLWAPI.dll"), stdcall, UInt32,
      (UInt16,),
      ch)
# ch : WCHAR -> UInt16
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t PathGetCharTypeW(
    uint16_t ch);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.PathGetCharTypeW(ch)
-- ch : WCHAR
-- 構造体/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 PathGetCharTypeW = lib.func('__stdcall', 'PathGetCharTypeW', 'uint32_t', ['uint16_t']);
// PathGetCharTypeW(ch)
// ch : WCHAR -> 'uint16_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  PathGetCharTypeW: { parameters: ["u16"], result: "u32" },
});
// lib.symbols.PathGetCharTypeW(ch)
// ch : WCHAR -> "u16"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t PathGetCharTypeW(
    uint16_t ch);
C, "SHLWAPI.dll");
// $ffi->PathGetCharTypeW(ch);
// ch : WCHAR
// 構造体/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);
    int PathGetCharTypeW(
        char ch   // WCHAR
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("shlwapi")]
lib LibSHLWAPI
  fun PathGetCharTypeW = PathGetCharTypeW(
    ch : UInt16   # WCHAR
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef PathGetCharTypeWNative = Uint32 Function(Uint16);
typedef PathGetCharTypeWDart = int Function(int);
final PathGetCharTypeW = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<PathGetCharTypeWNative, PathGetCharTypeWDart>('PathGetCharTypeW');
// ch : WCHAR -> Uint16
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PathGetCharTypeW(
  ch: WideChar   // WCHAR
): DWORD; stdcall;
  external 'SHLWAPI.dll' name 'PathGetCharTypeW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PathGetCharTypeW"
  c_PathGetCharTypeW :: Word16 -> IO Word32
-- ch : WCHAR -> Word16
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let pathgetchartypew =
  foreign "PathGetCharTypeW"
    (uint16_t @-> returning uint32_t)
(* ch : WCHAR -> uint16_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("PathGetCharTypeW" path-get-char-type-w :convention :stdcall) :uint32
  (ch :uint16))   ; WCHAR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PathGetCharTypeW = Win32::API::More->new('SHLWAPI',
    'DWORD PathGetCharTypeW(WORD ch)');
# my $ret = $PathGetCharTypeW->Call($ch);
# ch : WCHAR -> WORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い