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

StrCmpNCA

関数
C言語ロケールで先頭指定文字数だけ文字列を比較する。
DLLSHLWAPI.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

INT StrCmpNCA(
    LPCSTR pszStr1,
    LPCSTR pszStr2,
    INT nChar
);

パラメーター

名前方向説明
pszStr1LPCSTRin比較対象となる 1 つ目の null 終端文字列へのポインター。
pszStr2LPCSTRin比較対象となる 2 つ目の null 終端文字列へのポインター。
nCharINTin各文字列の先頭から比較する文字数。

戻り値の型: INT

公式ドキュメント

2 つの文字列の先頭から指定された文字数を、C ランタイム (ASCII) の照合規則を使用して比較します。比較では大文字と小文字が区別されます。(ANSI)

戻り値

型: int

部分文字列が同一の場合はゼロを返します。pszStr1 が指す文字列から取得した文字列が、pszStr2 が指す文字列から取得した文字列よりアルファベット順で大きい場合は正の値を返します。pszStr1 が指す文字列から取得した文字列が、pszStr2 が指す文字列から取得した文字列よりアルファベット順で小さい場合は負の値を返します。

解説(Remarks)

StrCmpNC は正規化された文字列の比較を目的として設計されている点に注意してください。これらの文字列はローカライズされておらず、ASCII 値 128 未満の文字のみで構成されます。そのため、ダブルバイト文字セット (DBCS) やその他の複数文字データに対しては正しく機能しません。

この関数は最初に一致しない文字を見つけ、1 つ目の文字列の文字が 2 つ目の文字列の文字より大きい場合は正の数を、小さい場合は負の数を、等しい場合はゼロを返します。たとえば、pszStr1="abczb"、pszStr2="abcdefg" とし、各文字列の先頭から 4 文字を比較するとします。StrCmpNC は、最初に一致しない文字が 4 番目の位置 (pszStr1 の "z" と pszStr2 の "d") にあると判断し、"z" の ASCII コードが "d" の ASCII コードより大きいため、正の値を返します。

Shlwapi.h に StrCmpNC が含まれていないバージョンの Windows では、この関数の個別の ANSI 版または Unicode 版を Shlwapi.dll から直接呼び出す必要があります。StrCmpNCA は序数 151、StrCmpNCW は序数 152 です。

メモ

shlwapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして StrCmpNC を定義します。エンコードに依存しないエイリアスと、エンコードに依存しないわけではないコードを混在させて使用すると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、「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 StrCmpNCA(
    LPCSTR pszStr1,
    LPCSTR pszStr2,
    INT nChar
);
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int StrCmpNCA(
    [MarshalAs(UnmanagedType.LPStr)] string pszStr1,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string pszStr2,   // LPCSTR
    int nChar   // INT
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function StrCmpNCA(
    <MarshalAs(UnmanagedType.LPStr)> pszStr1 As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> pszStr2 As String,   ' LPCSTR
    nChar As Integer   ' INT
) As Integer
End Function
' pszStr1 : LPCSTR
' pszStr2 : LPCSTR
' nChar : INT
Declare PtrSafe Function StrCmpNCA Lib "shlwapi" ( _
    ByVal pszStr1 As String, _
    ByVal pszStr2 As String, _
    ByVal nChar As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

StrCmpNCA = ctypes.windll.shlwapi.StrCmpNCA
StrCmpNCA.restype = ctypes.c_int
StrCmpNCA.argtypes = [
    wintypes.LPCSTR,  # pszStr1 : LPCSTR
    wintypes.LPCSTR,  # pszStr2 : LPCSTR
    ctypes.c_int,  # nChar : INT
]
require 'fiddle'
require 'fiddle/import'

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

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procStrCmpNCA = shlwapi.NewProc("StrCmpNCA")
)

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

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

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

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

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

(cffi:defcfun ("StrCmpNCA" str-cmp-nca :convention :stdcall) :int32
  (psz-str1 :string)   ; LPCSTR
  (psz-str2 :string)   ; LPCSTR
  (n-char :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $StrCmpNCA = Win32::API::More->new('SHLWAPI',
    'int StrCmpNCA(LPCSTR pszStr1, LPCSTR pszStr2, int nChar)');
# my $ret = $StrCmpNCA->Call($pszStr1, $pszStr2, $nChar);
# pszStr1 : LPCSTR -> LPCSTR
# pszStr2 : LPCSTR -> LPCSTR
# nChar : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目