Win32 API 日本語リファレンス
ホームGlobalization › lstrlenW

lstrlenW

関数
ワイド文字列の文字数を取得する。
DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

INT lstrlenW(
    LPCWSTR lpString
);

パラメーター

名前方向説明
lpStringLPCWSTRin長さを調べる null 終端文字列。

戻り値の型: INT

公式ドキュメント

指定された文字列の長さ(終端の null 文字を含まない)を取得します。(Unicode)

戻り値

型: int

この関数は文字列の長さを文字数で返します。lpStringNULL の場合、この関数は 0 を返します。

解説(Remarks)

メモ

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

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

各言語での呼び出し定義

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

INT lstrlenW(
    LPCWSTR lpString
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int lstrlenW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpString   // LPCWSTR
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function lstrlenW(
    <MarshalAs(UnmanagedType.LPWStr)> lpString As String   ' LPCWSTR
) As Integer
End Function
' lpString : LPCWSTR
Declare PtrSafe Function lstrlenW Lib "kernel32" ( _
    ByVal lpString 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

lstrlenW = ctypes.windll.kernel32.lstrlenW
lstrlenW.restype = ctypes.c_int
lstrlenW.argtypes = [
    wintypes.LPCWSTR,  # lpString : LPCWSTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
lstrlenW = Fiddle::Function.new(
  lib['lstrlenW'],
  [
    Fiddle::TYPE_VOIDP,  # lpString : LPCWSTR
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "kernel32")]
extern "system" {
    fn lstrlenW(
        lpString: *const u16  // LPCWSTR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode)]
public static extern int lstrlenW([MarshalAs(UnmanagedType.LPWStr)] string lpString);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_lstrlenW' -Namespace Win32 -PassThru
# $api::lstrlenW(lpString)
#uselib "KERNEL32.dll"
#func global lstrlenW "lstrlenW" wptr
; lstrlenW lpString   ; 戻り値は stat
; lpString : LPCWSTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global lstrlenW "lstrlenW" wstr
; res = lstrlenW(lpString)
; lpString : LPCWSTR -> "wstr"
; INT lstrlenW(LPCWSTR lpString)
#uselib "KERNEL32.dll"
#cfunc global lstrlenW "lstrlenW" wstr
; res = lstrlenW(lpString)
; lpString : LPCWSTR -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	proclstrlenW = kernel32.NewProc("lstrlenW")
)

// lpString (LPCWSTR)
r1, _, err := proclstrlenW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpString))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function lstrlenW(
  lpString: PWideChar   // LPCWSTR
): Integer; stdcall;
  external 'KERNEL32.dll' name 'lstrlenW';
result := DllCall("KERNEL32\lstrlenW"
    , "WStr", lpString   ; LPCWSTR
    , "Int")   ; return: INT
●lstrlenW(lpString) = DLL("KERNEL32.dll", "int lstrlenW(char*)")
# 呼び出し: lstrlenW(lpString)
# lpString : LPCWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "kernel32" fn lstrlenW(
    lpString: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc lstrlenW(
    lpString: WideCString  # LPCWSTR
): int32 {.importc: "lstrlenW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
int lstrlenW(
    const(wchar)* lpString   // LPCWSTR
);
ccall((:lstrlenW, "KERNEL32.dll"), stdcall, Int32,
      (Cwstring,),
      lpString)
# lpString : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t lstrlenW(
    const uint16_t* lpString);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.lstrlenW(lpString)
-- lpString : 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('KERNEL32.dll');
const lstrlenW = lib.func('__stdcall', 'lstrlenW', 'int32_t', ['str16']);
// lstrlenW(lpString)
// lpString : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  lstrlenW: { parameters: ["buffer"], result: "i32" },
});
// lib.symbols.lstrlenW(lpString)
// lpString : LPCWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t lstrlenW(
    const uint16_t* lpString);
C, "KERNEL32.dll");
// $ffi->lstrlenW(lpString);
// lpString : 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 Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class, W32APIOptions.UNICODE_OPTIONS);
    int lstrlenW(
        WString lpString   // LPCWSTR
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun lstrlenW = lstrlenW(
    lpString : 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 lstrlenWNative = Int32 Function(Pointer<Utf16>);
typedef lstrlenWDart = int Function(Pointer<Utf16>);
final lstrlenW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<lstrlenWNative, lstrlenWDart>('lstrlenW');
// lpString : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function lstrlenW(
  lpString: PWideChar   // LPCWSTR
): Integer; stdcall;
  external 'KERNEL32.dll' name 'lstrlenW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "lstrlenW"
  c_lstrlenW :: CWString -> IO Int32
-- lpString : LPCWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let lstrlenw =
  foreign "lstrlenW"
    ((ptr uint16_t) @-> returning int32_t)
(* lpString : LPCWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("lstrlenW" lstrlen-w :convention :stdcall) :int32
  (lp-string (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $lstrlenW = Win32::API::More->new('KERNEL32',
    'int lstrlenW(LPCWSTR lpString)');
# my $ret = $lstrlenW->Call($lpString);
# lpString : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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