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

StrCSpnIA

関数
大小文字無視で文字集合を含まない先頭長を取得する。
DLLSHLWAPI.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// SHLWAPI.dll  (ANSI / -A)
#include <windows.h>

INT StrCSpnIA(
    LPCSTR pszStr,
    LPCSTR pszSet
);

パラメーター

名前方向説明
pszStrLPCSTRin検索対象となる、null 終端文字列へのポインター。
pszSetLPCSTRin検索する文字を含む、null 終端文字列へのポインター。

戻り値の型: INT

公式ドキュメント

文字列から、指定した文字グループのいずれかが最初に出現する位置を検索します。検索では大文字と小文字は区別されず、終端の NULL 文字も検索パターンの一致対象に含まれます。(ANSI)

戻り値

型: int

pszStr 内で pszSet のいずれかの文字が最初に出現する位置のインデックスを返します。一致するものが見つからない場合は pszStr の長さを返します。

解説(Remarks)

この関数の戻り値は、pszStr の先頭から続く部分文字列のうち、pszSet に含まれる文字をまったく含まない部分の長さに等しくなります。

メモ

shlwapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして StrCSpnI を定義しています。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在して使用すると、不一致が生じてコンパイルエラーや実行時エラーの原因となる場合があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// SHLWAPI.dll  (ANSI / -A)
#include <windows.h>

INT StrCSpnIA(
    LPCSTR pszStr,
    LPCSTR pszSet
);
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int StrCSpnIA(
    [MarshalAs(UnmanagedType.LPStr)] string pszStr,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string pszSet   // LPCSTR
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function StrCSpnIA(
    <MarshalAs(UnmanagedType.LPStr)> pszStr As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> pszSet As String   ' LPCSTR
) As Integer
End Function
' pszStr : LPCSTR
' pszSet : LPCSTR
Declare PtrSafe Function StrCSpnIA Lib "shlwapi" ( _
    ByVal pszStr As String, _
    ByVal pszSet As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

StrCSpnIA = ctypes.windll.shlwapi.StrCSpnIA
StrCSpnIA.restype = ctypes.c_int
StrCSpnIA.argtypes = [
    wintypes.LPCSTR,  # pszStr : LPCSTR
    wintypes.LPCSTR,  # pszSet : LPCSTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
StrCSpnIA = Fiddle::Function.new(
  lib['StrCSpnIA'],
  [
    Fiddle::TYPE_VOIDP,  # pszStr : LPCSTR
    Fiddle::TYPE_VOIDP,  # pszSet : LPCSTR
  ],
  Fiddle::TYPE_INT)
#[link(name = "shlwapi")]
extern "system" {
    fn StrCSpnIA(
        pszStr: *const u8,  // LPCSTR
        pszSet: *const u8  // LPCSTR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi)]
public static extern int StrCSpnIA([MarshalAs(UnmanagedType.LPStr)] string pszStr, [MarshalAs(UnmanagedType.LPStr)] string pszSet);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_StrCSpnIA' -Namespace Win32 -PassThru
# $api::StrCSpnIA(pszStr, pszSet)
#uselib "SHLWAPI.dll"
#func global StrCSpnIA "StrCSpnIA" sptr, sptr
; StrCSpnIA pszStr, pszSet   ; 戻り値は stat
; pszStr : LPCSTR -> "sptr"
; pszSet : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SHLWAPI.dll"
#cfunc global StrCSpnIA "StrCSpnIA" str, str
; res = StrCSpnIA(pszStr, pszSet)
; pszStr : LPCSTR -> "str"
; pszSet : LPCSTR -> "str"
; INT StrCSpnIA(LPCSTR pszStr, LPCSTR pszSet)
#uselib "SHLWAPI.dll"
#cfunc global StrCSpnIA "StrCSpnIA" str, str
; res = StrCSpnIA(pszStr, pszSet)
; pszStr : LPCSTR -> "str"
; pszSet : LPCSTR -> "str"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procStrCSpnIA = shlwapi.NewProc("StrCSpnIA")
)

// pszStr (LPCSTR), pszSet (LPCSTR)
r1, _, err := procStrCSpnIA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pszStr))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pszSet))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function StrCSpnIA(
  pszStr: PAnsiChar;   // LPCSTR
  pszSet: PAnsiChar   // LPCSTR
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'StrCSpnIA';
result := DllCall("SHLWAPI\StrCSpnIA"
    , "AStr", pszStr   ; LPCSTR
    , "AStr", pszSet   ; LPCSTR
    , "Int")   ; return: INT
●StrCSpnIA(pszStr, pszSet) = DLL("SHLWAPI.dll", "int StrCSpnIA(char*, char*)")
# 呼び出し: StrCSpnIA(pszStr, pszSet)
# pszStr : LPCSTR -> "char*"
# pszSet : LPCSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "shlwapi" fn StrCSpnIA(
    pszStr: [*c]const u8, // LPCSTR
    pszSet: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) i32;
proc StrCSpnIA(
    pszStr: cstring,  # LPCSTR
    pszSet: cstring  # LPCSTR
): int32 {.importc: "StrCSpnIA", stdcall, dynlib: "SHLWAPI.dll".}
pragma(lib, "shlwapi");
extern(Windows)
int StrCSpnIA(
    const(char)* pszStr,   // LPCSTR
    const(char)* pszSet   // LPCSTR
);
ccall((:StrCSpnIA, "SHLWAPI.dll"), stdcall, Int32,
      (Cstring, Cstring),
      pszStr, pszSet)
# pszStr : LPCSTR -> Cstring
# pszSet : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t StrCSpnIA(
    const char* pszStr,
    const char* pszSet);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.StrCSpnIA(pszStr, pszSet)
-- pszStr : LPCSTR
-- pszSet : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const StrCSpnIA = lib.func('__stdcall', 'StrCSpnIA', 'int32_t', ['str', 'str']);
// StrCSpnIA(pszStr, pszSet)
// pszStr : LPCSTR -> 'str'
// pszSet : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  StrCSpnIA: { parameters: ["buffer", "buffer"], result: "i32" },
});
// lib.symbols.StrCSpnIA(pszStr, pszSet)
// pszStr : LPCSTR -> "buffer"
// pszSet : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t StrCSpnIA(
    const char* pszStr,
    const char* pszSet);
C, "SHLWAPI.dll");
// $ffi->StrCSpnIA(pszStr, pszSet);
// pszStr : LPCSTR
// pszSet : LPCSTR
// 構造体/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);
    int StrCSpnIA(
        String pszStr,   // LPCSTR
        String pszSet   // LPCSTR
    );
}
@[Link("shlwapi")]
lib LibSHLWAPI
  fun StrCSpnIA = StrCSpnIA(
    pszStr : UInt8*,   # LPCSTR
    pszSet : UInt8*   # LPCSTR
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef StrCSpnIANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>);
typedef StrCSpnIADart = int Function(Pointer<Utf8>, Pointer<Utf8>);
final StrCSpnIA = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<StrCSpnIANative, StrCSpnIADart>('StrCSpnIA');
// pszStr : LPCSTR -> Pointer<Utf8>
// pszSet : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function StrCSpnIA(
  pszStr: PAnsiChar;   // LPCSTR
  pszSet: PAnsiChar   // LPCSTR
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'StrCSpnIA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "StrCSpnIA"
  c_StrCSpnIA :: CString -> CString -> IO Int32
-- pszStr : LPCSTR -> CString
-- pszSet : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let strcspnia =
  foreign "StrCSpnIA"
    (string @-> string @-> returning int32_t)
(* pszStr : LPCSTR -> string *)
(* pszSet : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("StrCSpnIA" str-cspn-ia :convention :stdcall) :int32
  (psz-str :string)   ; LPCSTR
  (psz-set :string))   ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $StrCSpnIA = Win32::API::More->new('SHLWAPI',
    'int StrCSpnIA(LPCSTR pszStr, LPCSTR pszSet)');
# my $ret = $StrCSpnIA->Call($pszStr, $pszSet);
# pszStr : LPCSTR -> LPCSTR
# pszSet : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い