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

GetProfileStringW

関数
win.iniから文字列をUnicodeで取得する旧式関数。
DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD GetProfileStringW(
    LPCWSTR lpAppName,   // optional
    LPCWSTR lpKeyName,   // optional
    LPCWSTR lpDefault,   // optional
    LPWSTR lpReturnedString,   // optional
    DWORD nSize
);

パラメーター

名前方向
lpAppNameLPCWSTRinoptional
lpKeyNameLPCWSTRinoptional
lpDefaultLPCWSTRinoptional
lpReturnedStringLPWSTRoutoptional
nSizeDWORDin

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD GetProfileStringW(
    LPCWSTR lpAppName,   // optional
    LPCWSTR lpKeyName,   // optional
    LPCWSTR lpDefault,   // optional
    LPWSTR lpReturnedString,   // optional
    DWORD nSize
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint GetProfileStringW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpAppName,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string lpKeyName,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string lpDefault,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpReturnedString,   // LPWSTR optional, out
    uint nSize   // DWORD
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function GetProfileStringW(
    <MarshalAs(UnmanagedType.LPWStr)> lpAppName As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> lpKeyName As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> lpDefault As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> lpReturnedString As System.Text.StringBuilder,   ' LPWSTR optional, out
    nSize As UInteger   ' DWORD
) As UInteger
End Function
' lpAppName : LPCWSTR optional
' lpKeyName : LPCWSTR optional
' lpDefault : LPCWSTR optional
' lpReturnedString : LPWSTR optional, out
' nSize : DWORD
Declare PtrSafe Function GetProfileStringW Lib "kernel32" ( _
    ByVal lpAppName As LongPtr, _
    ByVal lpKeyName As LongPtr, _
    ByVal lpDefault As LongPtr, _
    ByVal lpReturnedString As LongPtr, _
    ByVal nSize As Long) 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

GetProfileStringW = ctypes.windll.kernel32.GetProfileStringW
GetProfileStringW.restype = wintypes.DWORD
GetProfileStringW.argtypes = [
    wintypes.LPCWSTR,  # lpAppName : LPCWSTR optional
    wintypes.LPCWSTR,  # lpKeyName : LPCWSTR optional
    wintypes.LPCWSTR,  # lpDefault : LPCWSTR optional
    wintypes.LPWSTR,  # lpReturnedString : LPWSTR optional, out
    wintypes.DWORD,  # nSize : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetProfileStringW = Fiddle::Function.new(
  lib['GetProfileStringW'],
  [
    Fiddle::TYPE_VOIDP,  # lpAppName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # lpKeyName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # lpDefault : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # lpReturnedString : LPWSTR optional, out
    -Fiddle::TYPE_INT,  # nSize : DWORD
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "kernel32")]
extern "system" {
    fn GetProfileStringW(
        lpAppName: *const u16,  // LPCWSTR optional
        lpKeyName: *const u16,  // LPCWSTR optional
        lpDefault: *const u16,  // LPCWSTR optional
        lpReturnedString: *mut u16,  // LPWSTR optional, out
        nSize: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode)]
public static extern uint GetProfileStringW([MarshalAs(UnmanagedType.LPWStr)] string lpAppName, [MarshalAs(UnmanagedType.LPWStr)] string lpKeyName, [MarshalAs(UnmanagedType.LPWStr)] string lpDefault, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpReturnedString, uint nSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetProfileStringW' -Namespace Win32 -PassThru
# $api::GetProfileStringW(lpAppName, lpKeyName, lpDefault, lpReturnedString, nSize)
#uselib "KERNEL32.dll"
#func global GetProfileStringW "GetProfileStringW" wptr, wptr, wptr, wptr, wptr
; GetProfileStringW lpAppName, lpKeyName, lpDefault, varptr(lpReturnedString), nSize   ; 戻り値は stat
; lpAppName : LPCWSTR optional -> "wptr"
; lpKeyName : LPCWSTR optional -> "wptr"
; lpDefault : LPCWSTR optional -> "wptr"
; lpReturnedString : LPWSTR optional, out -> "wptr"
; nSize : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global GetProfileStringW "GetProfileStringW" wstr, wstr, wstr, var, int
; res = GetProfileStringW(lpAppName, lpKeyName, lpDefault, lpReturnedString, nSize)
; lpAppName : LPCWSTR optional -> "wstr"
; lpKeyName : LPCWSTR optional -> "wstr"
; lpDefault : LPCWSTR optional -> "wstr"
; lpReturnedString : LPWSTR optional, out -> "var"
; nSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD GetProfileStringW(LPCWSTR lpAppName, LPCWSTR lpKeyName, LPCWSTR lpDefault, LPWSTR lpReturnedString, DWORD nSize)
#uselib "KERNEL32.dll"
#cfunc global GetProfileStringW "GetProfileStringW" wstr, wstr, wstr, var, int
; res = GetProfileStringW(lpAppName, lpKeyName, lpDefault, lpReturnedString, nSize)
; lpAppName : LPCWSTR optional -> "wstr"
; lpKeyName : LPCWSTR optional -> "wstr"
; lpDefault : LPCWSTR optional -> "wstr"
; lpReturnedString : LPWSTR optional, out -> "var"
; nSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetProfileStringW = kernel32.NewProc("GetProfileStringW")
)

// lpAppName (LPCWSTR optional), lpKeyName (LPCWSTR optional), lpDefault (LPCWSTR optional), lpReturnedString (LPWSTR optional, out), nSize (DWORD)
r1, _, err := procGetProfileStringW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpAppName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpKeyName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpDefault))),
	uintptr(lpReturnedString),
	uintptr(nSize),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function GetProfileStringW(
  lpAppName: PWideChar;   // LPCWSTR optional
  lpKeyName: PWideChar;   // LPCWSTR optional
  lpDefault: PWideChar;   // LPCWSTR optional
  lpReturnedString: PWideChar;   // LPWSTR optional, out
  nSize: DWORD   // DWORD
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetProfileStringW';
result := DllCall("KERNEL32\GetProfileStringW"
    , "WStr", lpAppName   ; LPCWSTR optional
    , "WStr", lpKeyName   ; LPCWSTR optional
    , "WStr", lpDefault   ; LPCWSTR optional
    , "Ptr", lpReturnedString   ; LPWSTR optional, out
    , "UInt", nSize   ; DWORD
    , "UInt")   ; return: DWORD
●GetProfileStringW(lpAppName, lpKeyName, lpDefault, lpReturnedString, nSize) = DLL("KERNEL32.dll", "dword GetProfileStringW(char*, char*, char*, char*, dword)")
# 呼び出し: GetProfileStringW(lpAppName, lpKeyName, lpDefault, lpReturnedString, nSize)
# lpAppName : LPCWSTR optional -> "char*"
# lpKeyName : LPCWSTR optional -> "char*"
# lpDefault : LPCWSTR optional -> "char*"
# lpReturnedString : LPWSTR optional, out -> "char*"
# nSize : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。