Win32 API 日本語リファレンス
ホームSystem.WinRT › WindowsGetStringRawBuffer

WindowsGetStringRawBuffer

関数
HSTRINGの内部UTF-16バッファへのポインタを取得する。
DLLapi-ms-win-core-winrt-string-l1-1-0.dll呼出規約winapi対応OSwindows8.0

シグネチャ

// api-ms-win-core-winrt-string-l1-1-0.dll
#include <windows.h>

LPWSTR WindowsGetStringRawBuffer(
    HSTRING string,   // optional
    DWORD* length   // optional
);

パラメーター

名前方向説明
stringHSTRINGinoptional生バッファを取得する対象のHSTRING。NULL可。
lengthDWORD*outoptional出力として文字列の文字数を受け取るDWORDポインタ。NULL可。

戻り値の型: LPWSTR

各言語での呼び出し定義

// api-ms-win-core-winrt-string-l1-1-0.dll
#include <windows.h>

LPWSTR WindowsGetStringRawBuffer(
    HSTRING string,   // optional
    DWORD* length   // optional
);
[DllImport("api-ms-win-core-winrt-string-l1-1-0.dll", ExactSpelling = true)]
static extern IntPtr WindowsGetStringRawBuffer(
    IntPtr string,   // HSTRING optional
    IntPtr length   // DWORD* optional, out
);
<DllImport("api-ms-win-core-winrt-string-l1-1-0.dll", ExactSpelling:=True)>
Public Shared Function WindowsGetStringRawBuffer(
    [string] As IntPtr,   ' HSTRING optional
    length As IntPtr   ' DWORD* optional, out
) As IntPtr
End Function
' string : HSTRING optional
' length : DWORD* optional, out
Declare PtrSafe Function WindowsGetStringRawBuffer Lib "api-ms-win-core-winrt-string-l1-1-0" ( _
    ByVal string As LongPtr, _
    ByVal length As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WindowsGetStringRawBuffer = ctypes.windll.LoadLibrary("api-ms-win-core-winrt-string-l1-1-0.dll").WindowsGetStringRawBuffer
WindowsGetStringRawBuffer.restype = wintypes.LPWSTR
WindowsGetStringRawBuffer.argtypes = [
    wintypes.HANDLE,  # string : HSTRING optional
    ctypes.POINTER(wintypes.DWORD),  # length : DWORD* optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('api-ms-win-core-winrt-string-l1-1-0.dll')
WindowsGetStringRawBuffer = Fiddle::Function.new(
  lib['WindowsGetStringRawBuffer'],
  [
    Fiddle::TYPE_VOIDP,  # string : HSTRING optional
    Fiddle::TYPE_VOIDP,  # length : DWORD* optional, out
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "api-ms-win-core-winrt-string-l1-1-0")]
extern "system" {
    fn WindowsGetStringRawBuffer(
        string: *mut core::ffi::c_void,  // HSTRING optional
        length: *mut u32  // DWORD* optional, out
    ) -> *mut u16;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("api-ms-win-core-winrt-string-l1-1-0.dll")]
public static extern IntPtr WindowsGetStringRawBuffer(IntPtr string, IntPtr length);
"@
$api = Add-Type -MemberDefinition $sig -Name 'api-ms-win-core-winrt-string-l1-1-0_WindowsGetStringRawBuffer' -Namespace Win32 -PassThru
# $api::WindowsGetStringRawBuffer(string, length)
#uselib "api-ms-win-core-winrt-string-l1-1-0.dll"
#func global WindowsGetStringRawBuffer "WindowsGetStringRawBuffer" sptr, sptr
; WindowsGetStringRawBuffer string, varptr(length)   ; 戻り値は stat
; string : HSTRING optional -> "sptr"
; length : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "api-ms-win-core-winrt-string-l1-1-0.dll"
#cfunc global WindowsGetStringRawBuffer "WindowsGetStringRawBuffer" sptr, var
; res = WindowsGetStringRawBuffer(string, length)
; string : HSTRING optional -> "sptr"
; length : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; LPWSTR WindowsGetStringRawBuffer(HSTRING string, DWORD* length)
#uselib "api-ms-win-core-winrt-string-l1-1-0.dll"
#cfunc global WindowsGetStringRawBuffer "WindowsGetStringRawBuffer" intptr, var
; res = WindowsGetStringRawBuffer(string, length)
; string : HSTRING optional -> "intptr"
; length : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	api_ms_win_core_winrt_string_l1_1_0 = windows.NewLazySystemDLL("api-ms-win-core-winrt-string-l1-1-0.dll")
	procWindowsGetStringRawBuffer = api_ms_win_core_winrt_string_l1_1_0.NewProc("WindowsGetStringRawBuffer")
)

// string (HSTRING optional), length (DWORD* optional, out)
r1, _, err := procWindowsGetStringRawBuffer.Call(
	uintptr(string),
	uintptr(length),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // LPWSTR
function WindowsGetStringRawBuffer(
  string: THandle;   // HSTRING optional
  length: Pointer   // DWORD* optional, out
): PWideChar; stdcall;
  external 'api-ms-win-core-winrt-string-l1-1-0.dll' name 'WindowsGetStringRawBuffer';
result := DllCall("api-ms-win-core-winrt-string-l1-1-0\WindowsGetStringRawBuffer"
    , "Ptr", string   ; HSTRING optional
    , "Ptr", length   ; DWORD* optional, out
    , "Ptr")   ; return: LPWSTR
●WindowsGetStringRawBuffer(string, length) = DLL("api-ms-win-core-winrt-string-l1-1-0.dll", "char* WindowsGetStringRawBuffer(void*, void*)")
# 呼び出し: WindowsGetStringRawBuffer(string, length)
# string : HSTRING optional -> "void*"
# length : DWORD* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef WindowsGetStringRawBufferNative = Pointer<Utf16> Function(Pointer<Void>, Pointer<Uint32>);
typedef WindowsGetStringRawBufferDart = Pointer<Utf16> Function(Pointer<Void>, Pointer<Uint32>);
final WindowsGetStringRawBuffer = DynamicLibrary.open('api-ms-win-core-winrt-string-l1-1-0.dll')
    .lookupFunction<WindowsGetStringRawBufferNative, WindowsGetStringRawBufferDart>('WindowsGetStringRawBuffer');
// string : HSTRING optional -> Pointer<Void>
// length : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WindowsGetStringRawBuffer(
  string: THandle;   // HSTRING optional
  length: Pointer   // DWORD* optional, out
): PWideChar; stdcall;
  external 'api-ms-win-core-winrt-string-l1-1-0.dll' name 'WindowsGetStringRawBuffer';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WindowsGetStringRawBuffer"
  c_WindowsGetStringRawBuffer :: Ptr () -> Ptr Word32 -> IO CWString
-- string : HSTRING optional -> Ptr ()
-- length : DWORD* optional, out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let windowsgetstringrawbuffer =
  foreign "WindowsGetStringRawBuffer"
    ((ptr void) @-> (ptr uint32_t) @-> returning (ptr uint16_t))
(* string : HSTRING optional -> (ptr void) *)
(* length : DWORD* optional, out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library api-ms-win-core-winrt-string-l1-1-0 (t "api-ms-win-core-winrt-string-l1-1-0.dll"))
(cffi:use-foreign-library api-ms-win-core-winrt-string-l1-1-0)

(cffi:defcfun ("WindowsGetStringRawBuffer" windows-get-string-raw-buffer :convention :stdcall) (:string :encoding :utf-16le)
  (string :pointer)   ; HSTRING optional
  (length :pointer))   ; DWORD* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WindowsGetStringRawBuffer = Win32::API::More->new('api-ms-win-core-winrt-string-l1-1-0',
    'LPWSTR WindowsGetStringRawBuffer(HANDLE string, LPVOID length)');
# my $ret = $WindowsGetStringRawBuffer->Call($string, $length);
# string : HSTRING optional -> HANDLE
# length : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。