ホーム › System.WindowsProgramming › GetPrivateProfileStringW

GetPrivateProfileStringW

関数

指定iniファイルから文字列をUnicodeで取得する。

DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

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

パラメーター

名前	型	方向
lpAppName	LPCWSTR	inoptional
lpKeyName	LPCWSTR	inoptional
lpDefault	LPCWSTR	inoptional
lpReturnedString	LPWSTR	outoptional
nSize	DWORD	in
lpFileName	LPCWSTR	inoptional

戻り値の型: DWORD

各言語での呼び出し定義

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

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

[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern uint GetPrivateProfileStringW(
    [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
    [MarshalAs(UnmanagedType.LPWStr)] string lpFileName   // LPCWSTR optional
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetPrivateProfileStringW(
    <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
    <MarshalAs(UnmanagedType.LPWStr)> lpFileName As String   ' LPCWSTR optional
) As UInteger
End Function

' lpAppName : LPCWSTR optional
' lpKeyName : LPCWSTR optional
' lpDefault : LPCWSTR optional
' lpReturnedString : LPWSTR optional, out
' nSize : DWORD
' lpFileName : LPCWSTR optional
Declare PtrSafe Function GetPrivateProfileStringW Lib "kernel32" ( _
    ByVal lpAppName As LongPtr, _
    ByVal lpKeyName As LongPtr, _
    ByVal lpDefault As LongPtr, _
    ByVal lpReturnedString As LongPtr, _
    ByVal nSize As Long, _
    ByVal lpFileName As LongPtr) 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

GetPrivateProfileStringW = ctypes.windll.kernel32.GetPrivateProfileStringW
GetPrivateProfileStringW.restype = wintypes.DWORD
GetPrivateProfileStringW.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
    wintypes.LPCWSTR,  # lpFileName : LPCWSTR optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetPrivateProfileStringW = Fiddle::Function.new(
  lib['GetPrivateProfileStringW'],
  [
    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_VOIDP,  # lpFileName : LPCWSTR optional
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "kernel32")]
extern "system" {
    fn GetPrivateProfileStringW(
        lpAppName: *const u16,  // LPCWSTR optional
        lpKeyName: *const u16,  // LPCWSTR optional
        lpDefault: *const u16,  // LPCWSTR optional
        lpReturnedString: *mut u16,  // LPWSTR optional, out
        nSize: u32,  // DWORD
        lpFileName: *const u16  // LPCWSTR optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern uint GetPrivateProfileStringW([MarshalAs(UnmanagedType.LPWStr)] string lpAppName, [MarshalAs(UnmanagedType.LPWStr)] string lpKeyName, [MarshalAs(UnmanagedType.LPWStr)] string lpDefault, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpReturnedString, uint nSize, [MarshalAs(UnmanagedType.LPWStr)] string lpFileName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetPrivateProfileStringW' -Namespace Win32 -PassThru
# $api::GetPrivateProfileStringW(lpAppName, lpKeyName, lpDefault, lpReturnedString, nSize, lpFileName)

#uselib "KERNEL32.dll"
#func global GetPrivateProfileStringW "GetPrivateProfileStringW" wptr, wptr, wptr, wptr, wptr, wptr
; GetPrivateProfileStringW lpAppName, lpKeyName, lpDefault, varptr(lpReturnedString), nSize, lpFileName   ; 戻り値は stat
; lpAppName : LPCWSTR optional -> "wptr"
; lpKeyName : LPCWSTR optional -> "wptr"
; lpDefault : LPCWSTR optional -> "wptr"
; lpReturnedString : LPWSTR optional, out -> "wptr"
; nSize : DWORD -> "wptr"
; lpFileName : LPCWSTR optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global GetPrivateProfileStringW "GetPrivateProfileStringW" wstr, wstr, wstr, var, int, wstr
; res = GetPrivateProfileStringW(lpAppName, lpKeyName, lpDefault, lpReturnedString, nSize, lpFileName)
; lpAppName : LPCWSTR optional -> "wstr"
; lpKeyName : LPCWSTR optional -> "wstr"
; lpDefault : LPCWSTR optional -> "wstr"
; lpReturnedString : LPWSTR optional, out -> "var"
; nSize : DWORD -> "int"
; lpFileName : LPCWSTR optional -> "wstr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GetPrivateProfileStringW "GetPrivateProfileStringW" wstr, wstr, wstr, sptr, int, wstr
; res = GetPrivateProfileStringW(lpAppName, lpKeyName, lpDefault, varptr(lpReturnedString), nSize, lpFileName)
; lpAppName : LPCWSTR optional -> "wstr"
; lpKeyName : LPCWSTR optional -> "wstr"
; lpDefault : LPCWSTR optional -> "wstr"
; lpReturnedString : LPWSTR optional, out -> "sptr"
; nSize : DWORD -> "int"
; lpFileName : LPCWSTR optional -> "wstr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; DWORD GetPrivateProfileStringW(LPCWSTR lpAppName, LPCWSTR lpKeyName, LPCWSTR lpDefault, LPWSTR lpReturnedString, DWORD nSize, LPCWSTR lpFileName)
#uselib "KERNEL32.dll"
#cfunc global GetPrivateProfileStringW "GetPrivateProfileStringW" wstr, wstr, wstr, var, int, wstr
; res = GetPrivateProfileStringW(lpAppName, lpKeyName, lpDefault, lpReturnedString, nSize, lpFileName)
; lpAppName : LPCWSTR optional -> "wstr"
; lpKeyName : LPCWSTR optional -> "wstr"
; lpDefault : LPCWSTR optional -> "wstr"
; lpReturnedString : LPWSTR optional, out -> "var"
; nSize : DWORD -> "int"
; lpFileName : LPCWSTR optional -> "wstr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD GetPrivateProfileStringW(LPCWSTR lpAppName, LPCWSTR lpKeyName, LPCWSTR lpDefault, LPWSTR lpReturnedString, DWORD nSize, LPCWSTR lpFileName)
#uselib "KERNEL32.dll"
#cfunc global GetPrivateProfileStringW "GetPrivateProfileStringW" wstr, wstr, wstr, intptr, int, wstr
; res = GetPrivateProfileStringW(lpAppName, lpKeyName, lpDefault, varptr(lpReturnedString), nSize, lpFileName)
; lpAppName : LPCWSTR optional -> "wstr"
; lpKeyName : LPCWSTR optional -> "wstr"
; lpDefault : LPCWSTR optional -> "wstr"
; lpReturnedString : LPWSTR optional, out -> "intptr"
; nSize : DWORD -> "int"
; lpFileName : LPCWSTR optional -> "wstr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetPrivateProfileStringW = kernel32.NewProc("GetPrivateProfileStringW")
)

// lpAppName (LPCWSTR optional), lpKeyName (LPCWSTR optional), lpDefault (LPCWSTR optional), lpReturnedString (LPWSTR optional, out), nSize (DWORD), lpFileName (LPCWSTR optional)
r1, _, err := procGetPrivateProfileStringW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpAppName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpKeyName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpDefault))),
	uintptr(lpReturnedString),
	uintptr(nSize),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpFileName))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD

function GetPrivateProfileStringW(
  lpAppName: PWideChar;   // LPCWSTR optional
  lpKeyName: PWideChar;   // LPCWSTR optional
  lpDefault: PWideChar;   // LPCWSTR optional
  lpReturnedString: PWideChar;   // LPWSTR optional, out
  nSize: DWORD;   // DWORD
  lpFileName: PWideChar   // LPCWSTR optional
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetPrivateProfileStringW';

result := DllCall("KERNEL32\GetPrivateProfileStringW"
    , "WStr", lpAppName   ; LPCWSTR optional
    , "WStr", lpKeyName   ; LPCWSTR optional
    , "WStr", lpDefault   ; LPCWSTR optional
    , "Ptr", lpReturnedString   ; LPWSTR optional, out
    , "UInt", nSize   ; DWORD
    , "WStr", lpFileName   ; LPCWSTR optional
    , "UInt")   ; return: DWORD

●GetPrivateProfileStringW(lpAppName, lpKeyName, lpDefault, lpReturnedString, nSize, lpFileName) = DLL("KERNEL32.dll", "dword GetPrivateProfileStringW(char*, char*, char*, char*, dword, char*)")
# 呼び出し: GetPrivateProfileStringW(lpAppName, lpKeyName, lpDefault, lpReturnedString, nSize, lpFileName)
# lpAppName : LPCWSTR optional -> "char*"
# lpKeyName : LPCWSTR optional -> "char*"
# lpDefault : LPCWSTR optional -> "char*"
# lpReturnedString : LPWSTR optional, out -> "char*"
# nSize : DWORD -> "dword"
# lpFileName : LPCWSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。