Win32 API 日本語リファレンス
ホームNetworking.Clustering › ResUtilGetSzProperty

ResUtilGetSzProperty

関数
プロパティリストから文字列プロパティ値を取得する。
DLLRESUTILS.dll呼出規約winapi対応OSwindowsserver2008

シグネチャ

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

DWORD ResUtilGetSzProperty(
    LPWSTR* ppszOutValue,
    const CLUSPROP_SZ* pValueStruct,
    LPCWSTR pszOldValue,   // optional
    BYTE** ppPropertyList,
    DWORD* pcbPropertyListSize
);

パラメーター

名前方向説明
ppszOutValueLPWSTR*out取得した文字列値を受け取るポインタ。LocalFreeで解放する。
pValueStructCLUSPROP_SZ*inプロパティリスト内の現在の文字列値を指すCLUSPROP_SZポインタ。
pszOldValueLPCWSTRinoptional値が無い場合に使用する既定の文字列。
ppPropertyListBYTE**inout入出力。プロパティリストの読み取り位置を指すポインタ。次要素へ前進する。
pcbPropertyListSizeDWORD*inout入出力。残りのプロパティリストのバイト数を保持するポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD ResUtilGetSzProperty(
    LPWSTR* ppszOutValue,
    const CLUSPROP_SZ* pValueStruct,
    LPCWSTR pszOldValue,   // optional
    BYTE** ppPropertyList,
    DWORD* pcbPropertyListSize
);
[DllImport("RESUTILS.dll", ExactSpelling = true)]
static extern uint ResUtilGetSzProperty(
    IntPtr ppszOutValue,   // LPWSTR* out
    IntPtr pValueStruct,   // CLUSPROP_SZ*
    [MarshalAs(UnmanagedType.LPWStr)] string pszOldValue,   // LPCWSTR optional
    IntPtr ppPropertyList,   // BYTE** in/out
    ref uint pcbPropertyListSize   // DWORD* in/out
);
<DllImport("RESUTILS.dll", ExactSpelling:=True)>
Public Shared Function ResUtilGetSzProperty(
    ppszOutValue As IntPtr,   ' LPWSTR* out
    pValueStruct As IntPtr,   ' CLUSPROP_SZ*
    <MarshalAs(UnmanagedType.LPWStr)> pszOldValue As String,   ' LPCWSTR optional
    ppPropertyList As IntPtr,   ' BYTE** in/out
    ByRef pcbPropertyListSize As UInteger   ' DWORD* in/out
) As UInteger
End Function
' ppszOutValue : LPWSTR* out
' pValueStruct : CLUSPROP_SZ*
' pszOldValue : LPCWSTR optional
' ppPropertyList : BYTE** in/out
' pcbPropertyListSize : DWORD* in/out
Declare PtrSafe Function ResUtilGetSzProperty Lib "resutils" ( _
    ByVal ppszOutValue As LongPtr, _
    ByVal pValueStruct As LongPtr, _
    ByVal pszOldValue As LongPtr, _
    ByVal ppPropertyList As LongPtr, _
    ByRef pcbPropertyListSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ResUtilGetSzProperty = ctypes.windll.resutils.ResUtilGetSzProperty
ResUtilGetSzProperty.restype = wintypes.DWORD
ResUtilGetSzProperty.argtypes = [
    ctypes.c_void_p,  # ppszOutValue : LPWSTR* out
    ctypes.c_void_p,  # pValueStruct : CLUSPROP_SZ*
    wintypes.LPCWSTR,  # pszOldValue : LPCWSTR optional
    ctypes.c_void_p,  # ppPropertyList : BYTE** in/out
    ctypes.POINTER(wintypes.DWORD),  # pcbPropertyListSize : DWORD* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('RESUTILS.dll')
ResUtilGetSzProperty = Fiddle::Function.new(
  lib['ResUtilGetSzProperty'],
  [
    Fiddle::TYPE_VOIDP,  # ppszOutValue : LPWSTR* out
    Fiddle::TYPE_VOIDP,  # pValueStruct : CLUSPROP_SZ*
    Fiddle::TYPE_VOIDP,  # pszOldValue : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # ppPropertyList : BYTE** in/out
    Fiddle::TYPE_VOIDP,  # pcbPropertyListSize : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "resutils")]
extern "system" {
    fn ResUtilGetSzProperty(
        ppszOutValue: *mut *mut u16,  // LPWSTR* out
        pValueStruct: *const CLUSPROP_SZ,  // CLUSPROP_SZ*
        pszOldValue: *const u16,  // LPCWSTR optional
        ppPropertyList: *mut *mut u8,  // BYTE** in/out
        pcbPropertyListSize: *mut u32  // DWORD* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("RESUTILS.dll")]
public static extern uint ResUtilGetSzProperty(IntPtr ppszOutValue, IntPtr pValueStruct, [MarshalAs(UnmanagedType.LPWStr)] string pszOldValue, IntPtr ppPropertyList, ref uint pcbPropertyListSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RESUTILS_ResUtilGetSzProperty' -Namespace Win32 -PassThru
# $api::ResUtilGetSzProperty(ppszOutValue, pValueStruct, pszOldValue, ppPropertyList, pcbPropertyListSize)
#uselib "RESUTILS.dll"
#func global ResUtilGetSzProperty "ResUtilGetSzProperty" sptr, sptr, sptr, sptr, sptr
; ResUtilGetSzProperty varptr(ppszOutValue), varptr(pValueStruct), pszOldValue, varptr(ppPropertyList), varptr(pcbPropertyListSize)   ; 戻り値は stat
; ppszOutValue : LPWSTR* out -> "sptr"
; pValueStruct : CLUSPROP_SZ* -> "sptr"
; pszOldValue : LPCWSTR optional -> "sptr"
; ppPropertyList : BYTE** in/out -> "sptr"
; pcbPropertyListSize : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "RESUTILS.dll"
#cfunc global ResUtilGetSzProperty "ResUtilGetSzProperty" var, var, wstr, var, var
; res = ResUtilGetSzProperty(ppszOutValue, pValueStruct, pszOldValue, ppPropertyList, pcbPropertyListSize)
; ppszOutValue : LPWSTR* out -> "var"
; pValueStruct : CLUSPROP_SZ* -> "var"
; pszOldValue : LPCWSTR optional -> "wstr"
; ppPropertyList : BYTE** in/out -> "var"
; pcbPropertyListSize : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD ResUtilGetSzProperty(LPWSTR* ppszOutValue, CLUSPROP_SZ* pValueStruct, LPCWSTR pszOldValue, BYTE** ppPropertyList, DWORD* pcbPropertyListSize)
#uselib "RESUTILS.dll"
#cfunc global ResUtilGetSzProperty "ResUtilGetSzProperty" var, var, wstr, var, var
; res = ResUtilGetSzProperty(ppszOutValue, pValueStruct, pszOldValue, ppPropertyList, pcbPropertyListSize)
; ppszOutValue : LPWSTR* out -> "var"
; pValueStruct : CLUSPROP_SZ* -> "var"
; pszOldValue : LPCWSTR optional -> "wstr"
; ppPropertyList : BYTE** in/out -> "var"
; pcbPropertyListSize : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	resutils = windows.NewLazySystemDLL("RESUTILS.dll")
	procResUtilGetSzProperty = resutils.NewProc("ResUtilGetSzProperty")
)

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

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

typedef ResUtilGetSzPropertyNative = Uint32 Function(Pointer<Pointer<Utf16>>, Pointer<Void>, Pointer<Utf16>, Pointer<Uint8>, Pointer<Uint32>);
typedef ResUtilGetSzPropertyDart = int Function(Pointer<Pointer<Utf16>>, Pointer<Void>, Pointer<Utf16>, Pointer<Uint8>, Pointer<Uint32>);
final ResUtilGetSzProperty = DynamicLibrary.open('RESUTILS.dll')
    .lookupFunction<ResUtilGetSzPropertyNative, ResUtilGetSzPropertyDart>('ResUtilGetSzProperty');
// ppszOutValue : LPWSTR* out -> Pointer<Pointer<Utf16>>
// pValueStruct : CLUSPROP_SZ* -> Pointer<Void>
// pszOldValue : LPCWSTR optional -> Pointer<Utf16>
// ppPropertyList : BYTE** in/out -> Pointer<Uint8>
// pcbPropertyListSize : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ResUtilGetSzProperty(
  ppszOutValue: PPWideChar;   // LPWSTR* out
  pValueStruct: Pointer;   // CLUSPROP_SZ*
  pszOldValue: PWideChar;   // LPCWSTR optional
  ppPropertyList: Pointer;   // BYTE** in/out
  pcbPropertyListSize: Pointer   // DWORD* in/out
): DWORD; stdcall;
  external 'RESUTILS.dll' name 'ResUtilGetSzProperty';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ResUtilGetSzProperty"
  c_ResUtilGetSzProperty :: Ptr CWString -> Ptr () -> CWString -> Ptr Word8 -> Ptr Word32 -> IO Word32
-- ppszOutValue : LPWSTR* out -> Ptr CWString
-- pValueStruct : CLUSPROP_SZ* -> Ptr ()
-- pszOldValue : LPCWSTR optional -> CWString
-- ppPropertyList : BYTE** in/out -> Ptr Word8
-- pcbPropertyListSize : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let resutilgetszproperty =
  foreign "ResUtilGetSzProperty"
    ((ptr (ptr uint16_t)) @-> (ptr void) @-> (ptr uint16_t) @-> (ptr uint8_t) @-> (ptr uint32_t) @-> returning uint32_t)
(* ppszOutValue : LPWSTR* out -> (ptr (ptr uint16_t)) *)
(* pValueStruct : CLUSPROP_SZ* -> (ptr void) *)
(* pszOldValue : LPCWSTR optional -> (ptr uint16_t) *)
(* ppPropertyList : BYTE** in/out -> (ptr uint8_t) *)
(* pcbPropertyListSize : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library resutils (t "RESUTILS.dll"))
(cffi:use-foreign-library resutils)

(cffi:defcfun ("ResUtilGetSzProperty" res-util-get-sz-property :convention :stdcall) :uint32
  (ppsz-out-value :pointer)   ; LPWSTR* out
  (p-value-struct :pointer)   ; CLUSPROP_SZ*
  (psz-old-value (:string :encoding :utf-16le))   ; LPCWSTR optional
  (pp-property-list :pointer)   ; BYTE** in/out
  (pcb-property-list-size :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ResUtilGetSzProperty = Win32::API::More->new('RESUTILS',
    'DWORD ResUtilGetSzProperty(LPVOID ppszOutValue, LPVOID pValueStruct, LPCWSTR pszOldValue, LPVOID ppPropertyList, LPVOID pcbPropertyListSize)');
# my $ret = $ResUtilGetSzProperty->Call($ppszOutValue, $pValueStruct, $pszOldValue, $ppPropertyList, $pcbPropertyListSize);
# ppszOutValue : LPWSTR* out -> LPVOID
# pValueStruct : CLUSPROP_SZ* -> LPVOID
# pszOldValue : LPCWSTR optional -> LPCWSTR
# ppPropertyList : BYTE** in/out -> LPVOID
# pcbPropertyListSize : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型