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