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
);

パラメーター

名前方向説明
lpAppNameLPCWSTRinoptionalwin.ini内のセクション名(ワイド)。NULLで全セクション名を列挙。
lpKeyNameLPCWSTRinoptional文字列を取得するキー名(ワイド)。NULLでセクション内全キー名を列挙。
lpDefaultLPCWSTRinoptionalキーが見つからない場合に返す既定文字列(ワイド)。
lpReturnedStringLPWSTRoutoptional取得した文字列を受け取るバッファ(ワイド)。
nSizeDWORDinバッファlpReturnedStringのサイズ(文字数)。

戻り値の型: 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 版の利用を推奨。
const std = @import("std");

extern "kernel32" fn GetProfileStringW(
    lpAppName: [*c]const u16, // LPCWSTR optional
    lpKeyName: [*c]const u16, // LPCWSTR optional
    lpDefault: [*c]const u16, // LPCWSTR optional
    lpReturnedString: [*c]u16, // LPWSTR optional, out
    nSize: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc GetProfileStringW(
    lpAppName: WideCString,  # LPCWSTR optional
    lpKeyName: WideCString,  # LPCWSTR optional
    lpDefault: WideCString,  # LPCWSTR optional
    lpReturnedString: ptr uint16,  # LPWSTR optional, out
    nSize: uint32  # DWORD
): uint32 {.importc: "GetProfileStringW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
uint GetProfileStringW(
    const(wchar)* lpAppName,   // LPCWSTR optional
    const(wchar)* lpKeyName,   // LPCWSTR optional
    const(wchar)* lpDefault,   // LPCWSTR optional
    wchar* lpReturnedString,   // LPWSTR optional, out
    uint nSize   // DWORD
);
ccall((:GetProfileStringW, "KERNEL32.dll"), stdcall, UInt32,
      (Cwstring, Cwstring, Cwstring, Ptr{UInt16}, UInt32),
      lpAppName, lpKeyName, lpDefault, lpReturnedString, nSize)
# lpAppName : LPCWSTR optional -> Cwstring
# lpKeyName : LPCWSTR optional -> Cwstring
# lpDefault : LPCWSTR optional -> Cwstring
# lpReturnedString : LPWSTR optional, out -> Ptr{UInt16}
# nSize : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetProfileStringW(
    const uint16_t* lpAppName,
    const uint16_t* lpKeyName,
    const uint16_t* lpDefault,
    uint16_t* lpReturnedString,
    uint32_t nSize);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetProfileStringW(lpAppName, lpKeyName, lpDefault, lpReturnedString, nSize)
-- lpAppName : LPCWSTR optional
-- lpKeyName : LPCWSTR optional
-- lpDefault : LPCWSTR optional
-- lpReturnedString : LPWSTR optional, out
-- nSize : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetProfileStringW = lib.func('__stdcall', 'GetProfileStringW', 'uint32_t', ['str16', 'str16', 'str16', 'uint16_t *', 'uint32_t']);
// GetProfileStringW(lpAppName, lpKeyName, lpDefault, lpReturnedString, nSize)
// lpAppName : LPCWSTR optional -> 'str16'
// lpKeyName : LPCWSTR optional -> 'str16'
// lpDefault : LPCWSTR optional -> 'str16'
// lpReturnedString : LPWSTR optional, out -> 'uint16_t *'
// nSize : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GetProfileStringW: { parameters: ["buffer", "buffer", "buffer", "buffer", "u32"], result: "u32" },
});
// lib.symbols.GetProfileStringW(lpAppName, lpKeyName, lpDefault, lpReturnedString, nSize)
// lpAppName : LPCWSTR optional -> "buffer"
// lpKeyName : LPCWSTR optional -> "buffer"
// lpDefault : LPCWSTR optional -> "buffer"
// lpReturnedString : LPWSTR optional, out -> "buffer"
// nSize : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetProfileStringW(
    const uint16_t* lpAppName,
    const uint16_t* lpKeyName,
    const uint16_t* lpDefault,
    uint16_t* lpReturnedString,
    uint32_t nSize);
C, "KERNEL32.dll");
// $ffi->GetProfileStringW(lpAppName, lpKeyName, lpDefault, lpReturnedString, nSize);
// lpAppName : LPCWSTR optional
// lpKeyName : LPCWSTR optional
// lpDefault : LPCWSTR optional
// lpReturnedString : LPWSTR optional, out
// nSize : DWORD
// 構造体/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 Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class, W32APIOptions.UNICODE_OPTIONS);
    int GetProfileStringW(
        WString lpAppName,   // LPCWSTR optional
        WString lpKeyName,   // LPCWSTR optional
        WString lpDefault,   // LPCWSTR optional
        char[] lpReturnedString,   // LPWSTR optional, out
        int nSize   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun GetProfileStringW = GetProfileStringW(
    lpAppName : UInt16*,   # LPCWSTR optional
    lpKeyName : UInt16*,   # LPCWSTR optional
    lpDefault : UInt16*,   # LPCWSTR optional
    lpReturnedString : UInt16*,   # LPWSTR optional, out
    nSize : UInt32   # DWORD
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetProfileStringWNative = Uint32 Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>, Uint32);
typedef GetProfileStringWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>, int);
final GetProfileStringW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetProfileStringWNative, GetProfileStringWDart>('GetProfileStringW');
// lpAppName : LPCWSTR optional -> Pointer<Utf16>
// lpKeyName : LPCWSTR optional -> Pointer<Utf16>
// lpDefault : LPCWSTR optional -> Pointer<Utf16>
// lpReturnedString : LPWSTR optional, out -> Pointer<Utf16>
// nSize : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
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';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetProfileStringW"
  c_GetProfileStringW :: CWString -> CWString -> CWString -> CWString -> Word32 -> IO Word32
-- lpAppName : LPCWSTR optional -> CWString
-- lpKeyName : LPCWSTR optional -> CWString
-- lpDefault : LPCWSTR optional -> CWString
-- lpReturnedString : LPWSTR optional, out -> CWString
-- nSize : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getprofilestringw =
  foreign "GetProfileStringW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> returning uint32_t)
(* lpAppName : LPCWSTR optional -> (ptr uint16_t) *)
(* lpKeyName : LPCWSTR optional -> (ptr uint16_t) *)
(* lpDefault : LPCWSTR optional -> (ptr uint16_t) *)
(* lpReturnedString : LPWSTR optional, out -> (ptr uint16_t) *)
(* nSize : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("GetProfileStringW" get-profile-string-w :convention :stdcall) :uint32
  (lp-app-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (lp-key-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (lp-default (:string :encoding :utf-16le))   ; LPCWSTR optional
  (lp-returned-string :pointer)   ; LPWSTR optional, out
  (n-size :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetProfileStringW = Win32::API::More->new('KERNEL32',
    'DWORD GetProfileStringW(LPCWSTR lpAppName, LPCWSTR lpKeyName, LPCWSTR lpDefault, LPWSTR lpReturnedString, DWORD nSize)');
# my $ret = $GetProfileStringW->Call($lpAppName, $lpKeyName, $lpDefault, $lpReturnedString, $nSize);
# lpAppName : LPCWSTR optional -> LPCWSTR
# lpKeyName : LPCWSTR optional -> LPCWSTR
# lpDefault : LPCWSTR optional -> LPCWSTR
# lpReturnedString : LPWSTR optional, out -> LPWSTR
# nSize : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い