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

WindowsPromoteStringBuffer

関数
事前確保したバッファを不変なHSTRINGへ昇格させる。
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>

HRESULT WindowsPromoteStringBuffer(
    HSTRING_BUFFER bufferHandle,
    HSTRING* string
);

パラメーター

名前方向説明
bufferHandleHSTRING_BUFFERinプロモート対象の事前確保済みHSTRING_BUFFERハンドル。
stringHSTRING*out出力として確定したHSTRINGを受け取るポインタ。

戻り値の型: HRESULT

各言語での呼び出し定義

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

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

WindowsPromoteStringBuffer = ctypes.windll.LoadLibrary("api-ms-win-core-winrt-string-l1-1-0.dll").WindowsPromoteStringBuffer
WindowsPromoteStringBuffer.restype = ctypes.c_int
WindowsPromoteStringBuffer.argtypes = [
    wintypes.HANDLE,  # bufferHandle : HSTRING_BUFFER
    ctypes.c_void_p,  # string : HSTRING* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('api-ms-win-core-winrt-string-l1-1-0.dll')
WindowsPromoteStringBuffer = Fiddle::Function.new(
  lib['WindowsPromoteStringBuffer'],
  [
    Fiddle::TYPE_VOIDP,  # bufferHandle : HSTRING_BUFFER
    Fiddle::TYPE_VOIDP,  # string : HSTRING* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "api-ms-win-core-winrt-string-l1-1-0")]
extern "system" {
    fn WindowsPromoteStringBuffer(
        bufferHandle: *mut core::ffi::c_void,  // HSTRING_BUFFER
        string: *mut *mut core::ffi::c_void  // HSTRING* out
    ) -> i32;
}
// 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 int WindowsPromoteStringBuffer(IntPtr bufferHandle, IntPtr string);
"@
$api = Add-Type -MemberDefinition $sig -Name 'api-ms-win-core-winrt-string-l1-1-0_WindowsPromoteStringBuffer' -Namespace Win32 -PassThru
# $api::WindowsPromoteStringBuffer(bufferHandle, string)
#uselib "api-ms-win-core-winrt-string-l1-1-0.dll"
#func global WindowsPromoteStringBuffer "WindowsPromoteStringBuffer" sptr, sptr
; WindowsPromoteStringBuffer bufferHandle, string   ; 戻り値は stat
; bufferHandle : HSTRING_BUFFER -> "sptr"
; string : HSTRING* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "api-ms-win-core-winrt-string-l1-1-0.dll"
#cfunc global WindowsPromoteStringBuffer "WindowsPromoteStringBuffer" sptr, sptr
; res = WindowsPromoteStringBuffer(bufferHandle, string)
; bufferHandle : HSTRING_BUFFER -> "sptr"
; string : HSTRING* out -> "sptr"
; HRESULT WindowsPromoteStringBuffer(HSTRING_BUFFER bufferHandle, HSTRING* string)
#uselib "api-ms-win-core-winrt-string-l1-1-0.dll"
#cfunc global WindowsPromoteStringBuffer "WindowsPromoteStringBuffer" intptr, intptr
; res = WindowsPromoteStringBuffer(bufferHandle, string)
; bufferHandle : HSTRING_BUFFER -> "intptr"
; string : HSTRING* out -> "intptr"
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")
	procWindowsPromoteStringBuffer = api_ms_win_core_winrt_string_l1_1_0.NewProc("WindowsPromoteStringBuffer")
)

// bufferHandle (HSTRING_BUFFER), string (HSTRING* out)
r1, _, err := procWindowsPromoteStringBuffer.Call(
	uintptr(bufferHandle),
	uintptr(string),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function WindowsPromoteStringBuffer(
  bufferHandle: THandle;   // HSTRING_BUFFER
  string: Pointer   // HSTRING* out
): Integer; stdcall;
  external 'api-ms-win-core-winrt-string-l1-1-0.dll' name 'WindowsPromoteStringBuffer';
result := DllCall("api-ms-win-core-winrt-string-l1-1-0\WindowsPromoteStringBuffer"
    , "Ptr", bufferHandle   ; HSTRING_BUFFER
    , "Ptr", string   ; HSTRING* out
    , "Int")   ; return: HRESULT
●WindowsPromoteStringBuffer(bufferHandle, string) = DLL("api-ms-win-core-winrt-string-l1-1-0.dll", "int WindowsPromoteStringBuffer(void*, void*)")
# 呼び出し: WindowsPromoteStringBuffer(bufferHandle, string)
# bufferHandle : HSTRING_BUFFER -> "void*"
# string : HSTRING* 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 WindowsPromoteStringBuffer(
    bufferHandle: ?*anyopaque, // HSTRING_BUFFER
    string: ?*anyopaque // HSTRING* out
) callconv(std.os.windows.WINAPI) i32;
proc WindowsPromoteStringBuffer(
    bufferHandle: pointer,  # HSTRING_BUFFER
    string: pointer  # HSTRING* out
): int32 {.importc: "WindowsPromoteStringBuffer", 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)
int WindowsPromoteStringBuffer(
    void* bufferHandle,   // HSTRING_BUFFER
    void* string   // HSTRING* out
);
ccall((:WindowsPromoteStringBuffer, "api-ms-win-core-winrt-string-l1-1-0.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{Cvoid}),
      bufferHandle, string)
# bufferHandle : HSTRING_BUFFER -> Ptr{Cvoid}
# string : HSTRING* out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WindowsPromoteStringBuffer(
    void* bufferHandle,
    void* string);
]]
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.WindowsPromoteStringBuffer(bufferHandle, string)
-- bufferHandle : HSTRING_BUFFER
-- string : HSTRING* 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 WindowsPromoteStringBuffer = lib.func('__stdcall', 'WindowsPromoteStringBuffer', 'int32_t', ['void *', 'void *']);
// WindowsPromoteStringBuffer(bufferHandle, string)
// bufferHandle : HSTRING_BUFFER -> 'void *'
// string : HSTRING* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("api-ms-win-core-winrt-string-l1-1-0.dll", {
  WindowsPromoteStringBuffer: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.WindowsPromoteStringBuffer(bufferHandle, string)
// bufferHandle : HSTRING_BUFFER -> "pointer"
// string : HSTRING* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WindowsPromoteStringBuffer(
    void* bufferHandle,
    void* string);
C, "api-ms-win-core-winrt-string-l1-1-0.dll");
// $ffi->WindowsPromoteStringBuffer(bufferHandle, string);
// bufferHandle : HSTRING_BUFFER
// string : HSTRING* 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);
    int WindowsPromoteStringBuffer(
        Pointer bufferHandle,   // HSTRING_BUFFER
        Pointer string   // HSTRING* out
    );
}
@[Link("api-ms-win-core-winrt-string-l1-1-0")]
lib Libapi-ms-win-core-winrt-string-l1-1-0
  fun WindowsPromoteStringBuffer = WindowsPromoteStringBuffer(
    bufferHandle : Void*,   # HSTRING_BUFFER
    string : Void*   # HSTRING* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WindowsPromoteStringBufferNative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef WindowsPromoteStringBufferDart = int Function(Pointer<Void>, Pointer<Void>);
final WindowsPromoteStringBuffer = DynamicLibrary.open('api-ms-win-core-winrt-string-l1-1-0.dll')
    .lookupFunction<WindowsPromoteStringBufferNative, WindowsPromoteStringBufferDart>('WindowsPromoteStringBuffer');
// bufferHandle : HSTRING_BUFFER -> Pointer<Void>
// string : HSTRING* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WindowsPromoteStringBuffer(
  bufferHandle: THandle;   // HSTRING_BUFFER
  string: Pointer   // HSTRING* out
): Integer; stdcall;
  external 'api-ms-win-core-winrt-string-l1-1-0.dll' name 'WindowsPromoteStringBuffer';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WindowsPromoteStringBuffer"
  c_WindowsPromoteStringBuffer :: Ptr () -> Ptr () -> IO Int32
-- bufferHandle : HSTRING_BUFFER -> Ptr ()
-- string : HSTRING* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let windowspromotestringbuffer =
  foreign "WindowsPromoteStringBuffer"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* bufferHandle : HSTRING_BUFFER -> (ptr void) *)
(* string : HSTRING* out -> (ptr void) *)
(* 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 ("WindowsPromoteStringBuffer" windows-promote-string-buffer :convention :stdcall) :int32
  (buffer-handle :pointer)   ; HSTRING_BUFFER
  (string :pointer))   ; HSTRING* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WindowsPromoteStringBuffer = Win32::API::More->new('api-ms-win-core-winrt-string-l1-1-0',
    'int WindowsPromoteStringBuffer(HANDLE bufferHandle, HANDLE string)');
# my $ret = $WindowsPromoteStringBuffer->Call($bufferHandle, $string);
# bufferHandle : HSTRING_BUFFER -> HANDLE
# string : HSTRING* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。