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

GetProfileIntW

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

シグネチャ

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

DWORD GetProfileIntW(
    LPCWSTR lpAppName,
    LPCWSTR lpKeyName,
    INT nDefault
);

パラメーター

名前型方向説明
lpAppNameLPCWSTRinキー名を含むセクションの名前。
lpKeyNameLPCWSTRin値を取得するキーの名前。この値は文字列の形式で指定します。 GetProfileInt 関数はその文字列を整数に変換し、その整数を返します。
nDefaultINTin初期化ファイル内でキー名が見つからない場合に返す既定値。

戻り値の型: DWORD

公式ドキュメント

Win.ini ファイルの指定されたセクション内のキーから整数を取得します。(Unicode)

戻り値

戻り値は、Win.ini 内でキー名に続く文字列に相当する整数です。関数がキーを見つけられない場合、戻り値は既定値になります。キーの値が 0 未満の場合、戻り値は 0 になります。

解説(Remarks)

キー名の値が数字とそれに続く非数値の文字で構成されている場合、関数は数字部分の値のみを返します。たとえば、次の行に対して関数は 102 を返します: KeyName=102abc。

Windows Server 2003 および Windows XP/2000: プロファイル関数の呼び出しは、初期化ファイルではなくレジストリにマップされる場合があります。このマッピングは、初期化ファイルとセクションがレジストリの次のキーの下に指定されている場合に発生します:HKEY_LOCAL_MACHINE\Software\Microsoft\Windows NT\CurrentVersion\IniFileMapping

操作がマップされている場合、 GetProfileInt 関数は初期化ファイルではなくレジストリから情報を取得します。格納場所が変わっても、この関数の動作には影響しません。

プロファイル関数は、次の手順で初期化情報を検索します。

  1. IniFileMapping キーの下のレジストリで初期化ファイルの名前を探します。
  2. lpAppName で指定されたセクション名を探します。これは、初期化ファイル名を持つキーの下にある名前付きの値、またはその名前のサブキーであるか、あるいは値としてもサブキーとしても存在しません。
  3. lpAppName で指定されたセクション名が名前付きの値である場合、その値は、そのセクションのキーがレジストリ内のどこにあるかを示します。
  4. lpAppName で指定されたセクション名がサブキーである場合、そのサブキーの下にある名前付きの値が、そのセクションのキーがレジストリ内のどこにあるかを示します。探しているキーが名前付きの値として存在しない場合は、そのキーが見つかるレジストリ内の既定の場所を示す、名前のない値 (<No Name> と表示されます) が存在します。
  5. lpAppName で指定されたセクション名が名前付きの値としてもサブキーとしても存在しない場合は、そのセクションのキーが見つかるレジストリ内の既定の場所を示す、名前のない値 (<No Name> と表示されます) が存在します。
  6. セクション名に対応するサブキーもエントリも存在しない場合は、ディスク上の実際の初期化ファイルを探し、その内容を読み取ります。
他のレジストリ上の場所を指定するレジストリの値を参照する際、.ini ファイルのマッピングの動作を変えるプレフィックスがいくつかあります。
メモ

winbase.h ヘッダーは GetProfileInt を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディングに依存しないエイリアスの使用と、エンコーディングに依存するコードを混在させると、不一致が生じ、コンパイルエラーや実行時エラーの原因となる場合があります。詳細については、「Conventions for Function Prototypes」を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

DWORD GetProfileIntW(
    LPCWSTR lpAppName,
    LPCWSTR lpKeyName,
    INT nDefault
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint GetProfileIntW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpAppName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string lpKeyName,   // LPCWSTR
    int nDefault   // INT
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function GetProfileIntW(
    <MarshalAs(UnmanagedType.LPWStr)> lpAppName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> lpKeyName As String,   ' LPCWSTR
    nDefault As Integer   ' INT
) As UInteger
End Function
' lpAppName : LPCWSTR
' lpKeyName : LPCWSTR
' nDefault : INT
Declare PtrSafe Function GetProfileIntW Lib "kernel32" ( _
    ByVal lpAppName As LongPtr, _
    ByVal lpKeyName As LongPtr, _
    ByVal nDefault 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

GetProfileIntW = ctypes.windll.kernel32.GetProfileIntW
GetProfileIntW.restype = wintypes.DWORD
GetProfileIntW.argtypes = [
    wintypes.LPCWSTR,  # lpAppName : LPCWSTR
    wintypes.LPCWSTR,  # lpKeyName : LPCWSTR
    ctypes.c_int,  # nDefault : INT
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetProfileIntW = Fiddle::Function.new(
  lib['GetProfileIntW'],
  [
    Fiddle::TYPE_VOIDP,  # lpAppName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpKeyName : LPCWSTR
    Fiddle::TYPE_INT,  # nDefault : INT
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "kernel32")]
extern "system" {
    fn GetProfileIntW(
        lpAppName: *const u16,  // LPCWSTR
        lpKeyName: *const u16,  // LPCWSTR
        nDefault: i32  // INT
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode)]
public static extern uint GetProfileIntW([MarshalAs(UnmanagedType.LPWStr)] string lpAppName, [MarshalAs(UnmanagedType.LPWStr)] string lpKeyName, int nDefault);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetProfileIntW' -Namespace Win32 -PassThru
# $api::GetProfileIntW(lpAppName, lpKeyName, nDefault)
#uselib "KERNEL32.dll"
#func global GetProfileIntW "GetProfileIntW" wptr, wptr, wptr
; GetProfileIntW lpAppName, lpKeyName, nDefault   ; 戻り値は stat
; lpAppName : LPCWSTR -> "wptr"
; lpKeyName : LPCWSTR -> "wptr"
; nDefault : INT -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global GetProfileIntW "GetProfileIntW" wstr, wstr, int
; res = GetProfileIntW(lpAppName, lpKeyName, nDefault)
; lpAppName : LPCWSTR -> "wstr"
; lpKeyName : LPCWSTR -> "wstr"
; nDefault : INT -> "int"
; DWORD GetProfileIntW(LPCWSTR lpAppName, LPCWSTR lpKeyName, INT nDefault)
#uselib "KERNEL32.dll"
#cfunc global GetProfileIntW "GetProfileIntW" wstr, wstr, int
; res = GetProfileIntW(lpAppName, lpKeyName, nDefault)
; lpAppName : LPCWSTR -> "wstr"
; lpKeyName : LPCWSTR -> "wstr"
; nDefault : INT -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetProfileIntW = kernel32.NewProc("GetProfileIntW")
)

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

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

typedef GetProfileIntWNative = Uint32 Function(Pointer<Utf16>, Pointer<Utf16>, Int32);
typedef GetProfileIntWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, int);
final GetProfileIntW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetProfileIntWNative, GetProfileIntWDart>('GetProfileIntW');
// lpAppName : LPCWSTR -> Pointer<Utf16>
// lpKeyName : LPCWSTR -> Pointer<Utf16>
// nDefault : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetProfileIntW(
  lpAppName: PWideChar;   // LPCWSTR
  lpKeyName: PWideChar;   // LPCWSTR
  nDefault: Integer   // INT
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetProfileIntW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetProfileIntW"
  c_GetProfileIntW :: CWString -> CWString -> Int32 -> IO Word32
-- lpAppName : LPCWSTR -> CWString
-- lpKeyName : LPCWSTR -> CWString
-- nDefault : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getprofileintw =
  foreign "GetProfileIntW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> int32_t @-> returning uint32_t)
(* lpAppName : LPCWSTR -> (ptr uint16_t) *)
(* lpKeyName : LPCWSTR -> (ptr uint16_t) *)
(* nDefault : INT -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

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

関連項目

文字セット違い
公式の関連項目