Win32 API 日本語リファレンス
ホームFoundation › SysStringByteLen

SysStringByteLen

関数
BSTR文字列のバイト長を取得する。
DLLOLEAUT32.dll呼出規約winapi

シグネチャ

// OLEAUT32.dll
#include <windows.h>

DWORD SysStringByteLen(
    LPWSTR bstr   // optional
);

パラメーター

名前方向説明
bstrLPWSTRinoptional事前に割り当てられた文字列。

戻り値の型: DWORD

公式ドキュメント

BSTR の長さ(バイト単位)を返します。

戻り値

bstr のバイト数(終端の null 文字は含みません)。bstr が null の場合、戻り値は 0 です。

解説(Remarks)

BSTR に埋め込まれた null 文字が含まれている場合、戻り値は strlen(bstr) と異なることがあります。この関数は常に、BSTR の割り当てに使用された SysAllocStringByteLen 関数の len パラメーターで指定されたバイト数を返します。

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

各言語での呼び出し定義

// OLEAUT32.dll
#include <windows.h>

DWORD SysStringByteLen(
    LPWSTR bstr   // optional
);
[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern uint SysStringByteLen(
    [MarshalAs(UnmanagedType.LPWStr)] string bstr   // LPWSTR optional
);
<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Function SysStringByteLen(
    <MarshalAs(UnmanagedType.LPWStr)> bstr As String   ' LPWSTR optional
) As UInteger
End Function
' bstr : LPWSTR optional
Declare PtrSafe Function SysStringByteLen Lib "oleaut32" ( _
    ByVal bstr As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SysStringByteLen = ctypes.windll.oleaut32.SysStringByteLen
SysStringByteLen.restype = wintypes.DWORD
SysStringByteLen.argtypes = [
    wintypes.LPCWSTR,  # bstr : LPWSTR optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLEAUT32.dll')
SysStringByteLen = Fiddle::Function.new(
  lib['SysStringByteLen'],
  [
    Fiddle::TYPE_VOIDP,  # bstr : LPWSTR optional
  ],
  -Fiddle::TYPE_INT)
#[link(name = "oleaut32")]
extern "system" {
    fn SysStringByteLen(
        bstr: *mut u16  // LPWSTR optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("OLEAUT32.dll")]
public static extern uint SysStringByteLen([MarshalAs(UnmanagedType.LPWStr)] string bstr);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLEAUT32_SysStringByteLen' -Namespace Win32 -PassThru
# $api::SysStringByteLen(bstr)
#uselib "OLEAUT32.dll"
#func global SysStringByteLen "SysStringByteLen" sptr
; SysStringByteLen bstr   ; 戻り値は stat
; bstr : LPWSTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "OLEAUT32.dll"
#cfunc global SysStringByteLen "SysStringByteLen" wstr
; res = SysStringByteLen(bstr)
; bstr : LPWSTR optional -> "wstr"
; DWORD SysStringByteLen(LPWSTR bstr)
#uselib "OLEAUT32.dll"
#cfunc global SysStringByteLen "SysStringByteLen" wstr
; res = SysStringByteLen(bstr)
; bstr : LPWSTR optional -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	oleaut32 = windows.NewLazySystemDLL("OLEAUT32.dll")
	procSysStringByteLen = oleaut32.NewProc("SysStringByteLen")
)

// bstr (LPWSTR optional)
r1, _, err := procSysStringByteLen.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(bstr))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function SysStringByteLen(
  bstr: PWideChar   // LPWSTR optional
): DWORD; stdcall;
  external 'OLEAUT32.dll' name 'SysStringByteLen';
result := DllCall("OLEAUT32\SysStringByteLen"
    , "WStr", bstr   ; LPWSTR optional
    , "UInt")   ; return: DWORD
●SysStringByteLen(bstr) = DLL("OLEAUT32.dll", "dword SysStringByteLen(char*)")
# 呼び出し: SysStringByteLen(bstr)
# bstr : LPWSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "oleaut32" fn SysStringByteLen(
    bstr: [*c]const u16 // LPWSTR optional
) callconv(std.os.windows.WINAPI) u32;
proc SysStringByteLen(
    bstr: WideCString  # LPWSTR optional
): uint32 {.importc: "SysStringByteLen", stdcall, dynlib: "OLEAUT32.dll".}
pragma(lib, "oleaut32");
extern(Windows)
uint SysStringByteLen(
    const(wchar)* bstr   // LPWSTR optional
);
ccall((:SysStringByteLen, "OLEAUT32.dll"), stdcall, UInt32,
      (Cwstring,),
      bstr)
# bstr : LPWSTR optional -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t SysStringByteLen(
    const uint16_t* bstr);
]]
local oleaut32 = ffi.load("oleaut32")
-- oleaut32.SysStringByteLen(bstr)
-- bstr : LPWSTR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('OLEAUT32.dll');
const SysStringByteLen = lib.func('__stdcall', 'SysStringByteLen', 'uint32_t', ['str16']);
// SysStringByteLen(bstr)
// bstr : LPWSTR optional -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("OLEAUT32.dll", {
  SysStringByteLen: { parameters: ["buffer"], result: "u32" },
});
// lib.symbols.SysStringByteLen(bstr)
// bstr : LPWSTR optional -> "buffer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t SysStringByteLen(
    const uint16_t* bstr);
C, "OLEAUT32.dll");
// $ffi->SysStringByteLen(bstr);
// bstr : LPWSTR optional
// 構造体/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 Oleaut32 extends StdCallLibrary {
    Oleaut32 INSTANCE = Native.load("oleaut32", Oleaut32.class);
    int SysStringByteLen(
        WString bstr   // LPWSTR optional
    );
}
@[Link("oleaut32")]
lib LibOLEAUT32
  fun SysStringByteLen = SysStringByteLen(
    bstr : UInt16*   # LPWSTR optional
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SysStringByteLenNative = Uint32 Function(Pointer<Utf16>);
typedef SysStringByteLenDart = int Function(Pointer<Utf16>);
final SysStringByteLen = DynamicLibrary.open('OLEAUT32.dll')
    .lookupFunction<SysStringByteLenNative, SysStringByteLenDart>('SysStringByteLen');
// bstr : LPWSTR optional -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SysStringByteLen(
  bstr: PWideChar   // LPWSTR optional
): DWORD; stdcall;
  external 'OLEAUT32.dll' name 'SysStringByteLen';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SysStringByteLen"
  c_SysStringByteLen :: CWString -> IO Word32
-- bstr : LPWSTR optional -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let sysstringbytelen =
  foreign "SysStringByteLen"
    ((ptr uint16_t) @-> returning uint32_t)
(* bstr : LPWSTR optional -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library oleaut32 (t "OLEAUT32.dll"))
(cffi:use-foreign-library oleaut32)

(cffi:defcfun ("SysStringByteLen" sys-string-byte-len :convention :stdcall) :uint32
  (bstr (:string :encoding :utf-16le)))   ; LPWSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SysStringByteLen = Win32::API::More->new('OLEAUT32',
    'DWORD SysStringByteLen(LPCWSTR bstr)');
# my $ret = $SysStringByteLen->Call($bstr);
# bstr : LPWSTR optional -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。