StrCSpnIW
関数大小文字無視で文字集合を含まない先頭長を取得する。
シグネチャ
// SHLWAPI.dll (Unicode / -W)
#include <windows.h>
INT StrCSpnIW(
LPCWSTR pszStr,
LPCWSTR pszSet
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| pszStr | LPCWSTR | in | 検索対象となる null 終端文字列へのポインター。 |
| pszSet | LPCWSTR | in | 検索する文字を含む null 終端文字列へのポインター。 |
戻り値の型: INT
公式ドキュメント
文字列を検索し、指定した文字グループのいずれかが最初に出現する位置を探します。検索では大文字と小文字は区別されず、終端の NULL 文字も検索パターンの一致対象に含まれます。(Unicode)
戻り値
型: int
pszSet 内のいずれかの文字が pszStr 内で最初に出現するインデックスを返します。一致が見つからない場合は pszStr の長さを返します。
解説(Remarks)
この関数の戻り値は、pszStr の先頭部分文字列のうち pszSet 内のいずれの文字も含まない部分の長さに等しくなります。
メモ
shlwapi.h ヘッダーは StrCSpnI をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規則を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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 (Unicode / -W)
#include <windows.h>
INT StrCSpnIW(
LPCWSTR pszStr,
LPCWSTR pszSet
);[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int StrCSpnIW(
[MarshalAs(UnmanagedType.LPWStr)] string pszStr, // LPCWSTR
[MarshalAs(UnmanagedType.LPWStr)] string pszSet // LPCWSTR
);<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function StrCSpnIW(
<MarshalAs(UnmanagedType.LPWStr)> pszStr As String, ' LPCWSTR
<MarshalAs(UnmanagedType.LPWStr)> pszSet As String ' LPCWSTR
) As Integer
End Function' pszStr : LPCWSTR
' pszSet : LPCWSTR
Declare PtrSafe Function StrCSpnIW Lib "shlwapi" ( _
ByVal pszStr As LongPtr, _
ByVal pszSet As LongPtr) 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
StrCSpnIW = ctypes.windll.shlwapi.StrCSpnIW
StrCSpnIW.restype = ctypes.c_int
StrCSpnIW.argtypes = [
wintypes.LPCWSTR, # pszStr : LPCWSTR
wintypes.LPCWSTR, # pszSet : LPCWSTR
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('SHLWAPI.dll')
StrCSpnIW = Fiddle::Function.new(
lib['StrCSpnIW'],
[
Fiddle::TYPE_VOIDP, # pszStr : LPCWSTR
Fiddle::TYPE_VOIDP, # pszSet : LPCWSTR
],
Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "shlwapi")]
extern "system" {
fn StrCSpnIW(
pszStr: *const u16, // LPCWSTR
pszSet: *const u16 // LPCWSTR
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode)]
public static extern int StrCSpnIW([MarshalAs(UnmanagedType.LPWStr)] string pszStr, [MarshalAs(UnmanagedType.LPWStr)] string pszSet);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_StrCSpnIW' -Namespace Win32 -PassThru
# $api::StrCSpnIW(pszStr, pszSet)#uselib "SHLWAPI.dll"
#func global StrCSpnIW "StrCSpnIW" wptr, wptr
; StrCSpnIW pszStr, pszSet ; 戻り値は stat
; pszStr : LPCWSTR -> "wptr"
; pszSet : LPCWSTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "SHLWAPI.dll"
#cfunc global StrCSpnIW "StrCSpnIW" wstr, wstr
; res = StrCSpnIW(pszStr, pszSet)
; pszStr : LPCWSTR -> "wstr"
; pszSet : LPCWSTR -> "wstr"; INT StrCSpnIW(LPCWSTR pszStr, LPCWSTR pszSet)
#uselib "SHLWAPI.dll"
#cfunc global StrCSpnIW "StrCSpnIW" wstr, wstr
; res = StrCSpnIW(pszStr, pszSet)
; pszStr : LPCWSTR -> "wstr"
; pszSet : LPCWSTR -> "wstr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
procStrCSpnIW = shlwapi.NewProc("StrCSpnIW")
)
// pszStr (LPCWSTR), pszSet (LPCWSTR)
r1, _, err := procStrCSpnIW.Call(
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszStr))),
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszSet))),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INTfunction StrCSpnIW(
pszStr: PWideChar; // LPCWSTR
pszSet: PWideChar // LPCWSTR
): Integer; stdcall;
external 'SHLWAPI.dll' name 'StrCSpnIW';result := DllCall("SHLWAPI\StrCSpnIW"
, "WStr", pszStr ; LPCWSTR
, "WStr", pszSet ; LPCWSTR
, "Int") ; return: INT●StrCSpnIW(pszStr, pszSet) = DLL("SHLWAPI.dll", "int StrCSpnIW(char*, char*)")
# 呼び出し: StrCSpnIW(pszStr, pszSet)
# pszStr : LPCWSTR -> "char*"
# pszSet : LPCWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "shlwapi" fn StrCSpnIW(
pszStr: [*c]const u16, // LPCWSTR
pszSet: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc StrCSpnIW(
pszStr: WideCString, # LPCWSTR
pszSet: WideCString # LPCWSTR
): int32 {.importc: "StrCSpnIW", stdcall, dynlib: "SHLWAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "shlwapi");
extern(Windows)
int StrCSpnIW(
const(wchar)* pszStr, // LPCWSTR
const(wchar)* pszSet // LPCWSTR
);ccall((:StrCSpnIW, "SHLWAPI.dll"), stdcall, Int32,
(Cwstring, Cwstring),
pszStr, pszSet)
# pszStr : LPCWSTR -> Cwstring
# pszSet : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
int32_t StrCSpnIW(
const uint16_t* pszStr,
const uint16_t* pszSet);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.StrCSpnIW(pszStr, pszSet)
-- pszStr : LPCWSTR
-- pszSet : LPCWSTR
-- 構造体/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 StrCSpnIW = lib.func('__stdcall', 'StrCSpnIW', 'int32_t', ['str16', 'str16']);
// StrCSpnIW(pszStr, pszSet)
// pszStr : LPCWSTR -> 'str16'
// pszSet : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHLWAPI.dll", {
StrCSpnIW: { parameters: ["buffer", "buffer"], result: "i32" },
});
// lib.symbols.StrCSpnIW(pszStr, pszSet)
// pszStr : LPCWSTR -> "buffer"
// pszSet : LPCWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t StrCSpnIW(
const uint16_t* pszStr,
const uint16_t* pszSet);
C, "SHLWAPI.dll");
// $ffi->StrCSpnIW(pszStr, pszSet);
// pszStr : LPCWSTR
// pszSet : LPCWSTR
// 構造体/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 StrCSpnIW(
WString pszStr, // LPCWSTR
WString pszSet // LPCWSTR
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("shlwapi")]
lib LibSHLWAPI
fun StrCSpnIW = StrCSpnIW(
pszStr : UInt16*, # LPCWSTR
pszSet : UInt16* # LPCWSTR
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef StrCSpnIWNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>);
typedef StrCSpnIWDart = int Function(Pointer<Utf16>, Pointer<Utf16>);
final StrCSpnIW = DynamicLibrary.open('SHLWAPI.dll')
.lookupFunction<StrCSpnIWNative, StrCSpnIWDart>('StrCSpnIW');
// pszStr : LPCWSTR -> Pointer<Utf16>
// pszSet : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function StrCSpnIW(
pszStr: PWideChar; // LPCWSTR
pszSet: PWideChar // LPCWSTR
): Integer; stdcall;
external 'SHLWAPI.dll' name 'StrCSpnIW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "StrCSpnIW"
c_StrCSpnIW :: CWString -> CWString -> IO Int32
-- pszStr : LPCWSTR -> CWString
-- pszSet : LPCWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let strcspniw =
foreign "StrCSpnIW"
((ptr uint16_t) @-> (ptr uint16_t) @-> returning int32_t)
(* pszStr : LPCWSTR -> (ptr uint16_t) *)
(* pszSet : LPCWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)
(cffi:defcfun ("StrCSpnIW" str-cspn-iw :convention :stdcall) :int32
(psz-str (:string :encoding :utf-16le)) ; LPCWSTR
(psz-set (:string :encoding :utf-16le))) ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $StrCSpnIW = Win32::API::More->new('SHLWAPI',
'int StrCSpnIW(LPCWSTR pszStr, LPCWSTR pszSet)');
# my $ret = $StrCSpnIW->Call($pszStr, $pszSet);
# pszStr : LPCWSTR -> LPCWSTR
# pszSet : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
文字セット違い
- f StrCSpnIA (ANSI版) — 大小文字無視で文字集合を含まない先頭長を取得する。