GetProfileSectionA
関数シグネチャ
// KERNEL32.dll (ANSI / -A)
#include <windows.h>
DWORD GetProfileSectionA(
LPCSTR lpAppName,
LPSTR lpReturnedString, // optional
DWORD nSize
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| lpAppName | LPCSTR | in | Win.ini ファイル内のセクションの名前。 |
| lpReturnedString | LPSTR | outoptional | 名前付きセクションに関連付けられたキーと値を受け取るバッファーへのポインター。バッファーには 1 つ以上の null 終端文字列が格納され、最後の文字列の後には 2 つ目の null 文字が続きます。 |
| nSize | DWORD | in | lpReturnedString パラメーターが指すバッファーのサイズ (文字数)。 プロファイルセクションの最大サイズは 32,767 文字です。 |
戻り値の型: DWORD
公式ドキュメント
Win.ini ファイルの指定されたセクションに含まれるすべてのキーと値を取得します。(ANSI)
戻り値
戻り値は、指定されたバッファーにコピーされた文字数を示します (終端の null 文字は含みません)。バッファーが、名前付きセクションに関連付けられたすべてのキーと値を格納するのに十分な大きさでない場合、戻り値は nSize で指定されたサイズから 2 を引いた値になります。
解説(Remarks)
返されるキーと値の形式は、1 つ以上の null 終端文字列とそれに続く最後の null 文字です。各文字列は次の形式になります: key=string
GetProfileSection 関数は大文字と小文字を区別しません。文字列には大文字と小文字を混在させることができます。
この操作はアトミックです。セクションのキーと値がバッファーにコピーされている間、Win.ini ファイルへの更新は許可されません。
Windows Server 2003 および Windows XP/2000: プロファイル関数の呼び出しは、初期化ファイルではなくレジストリにマップされる場合があります。このマッピングは、初期化ファイルとセクションがレジストリの次のキーの下に指定されている場合に発生します: HKEY_LOCAL_MACHINE\Software\Microsoft\Windows NT\CurrentVersion\IniFileMapping。
操作がマップされている場合、 GetProfileSection 関数は初期化ファイルからではなくレジストリから情報を取得します。格納場所が変わっても、この関数の動作には影響しません。
プロファイル関数は、次の手順で初期化情報を探します。
- IniFileMapping キーの下のレジストリで、初期化ファイルの名前を探します。
- lpAppName で指定されたセクション名を探します。これは、初期化ファイルの名前を持つキーの下にある名前付きの値であるか、この名前のサブキーであるか、あるいは値としてもサブキーとしても存在しません。
- lpAppName で指定されたセクション名が名前付きの値である場合、その値は、そのセクションのキーがレジストリのどこにあるかを示します。
- lpAppName で指定されたセクション名がサブキーである場合、そのサブキーの下にある名前付きの値が、そのセクションのキーがレジストリのどこにあるかを示します。探しているキーが名前付きの値として存在しない場合は、そのキーが見つかるレジストリ内の既定の場所を示す名前のない値 (<No Name> と表示されます) が存在します。
- lpAppName で指定されたセクション名が名前付きの値としてもサブキーとしても存在しない場合は、そのセクションのキーが見つかるレジストリ内の既定の場所を示す名前のない値 (<No Name> と表示されます) が存在します。
- セクション名に対応するサブキーまたはエントリがない場合は、ディスク上の実際の初期化ファイルを探し、その内容を読み取ります。
- ! - この文字は、すべての書き込みをレジストリとディスク上の .ini ファイルの両方に対して強制的に行わせます。
- # - この文字は、セットアップ後に新しいユーザーが初めてログオンしたときに、レジストリの値が Windows 3.1 の .ini ファイル内の値に設定されるようにします。
- @ - この文字は、要求されたデータがレジストリ内に見つからない場合でも、ディスク上の .ini ファイルからの読み取りが行われないようにします。
- USR: - このプレフィックスは HKEY_CURRENT_USER を表し、プレフィックスに続くテキストはそのキーからの相対パスになります。
- SYS: - このプレフィックスは HKEY_LOCAL_MACHINE\SOFTWARE を表し、プレフィックスに続くテキストはそのキーからの相対パスになります。
winbase.h ヘッダーは、GetProfileSection を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版と Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング中立のエイリアスと、エンコーディング中立でないコードを混在させて使用すると、不一致が生じ、コンパイルエラーや実行時エラーの原因となる場合があります。詳細については、「関数プロトタイプの規則」を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll (ANSI / -A)
#include <windows.h>
DWORD GetProfileSectionA(
LPCSTR lpAppName,
LPSTR lpReturnedString, // optional
DWORD nSize
);[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint GetProfileSectionA(
[MarshalAs(UnmanagedType.LPStr)] string lpAppName, // LPCSTR
[MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpReturnedString, // LPSTR optional, out
uint nSize // DWORD
);<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function GetProfileSectionA(
<MarshalAs(UnmanagedType.LPStr)> lpAppName As String, ' LPCSTR
<MarshalAs(UnmanagedType.LPStr)> lpReturnedString As System.Text.StringBuilder, ' LPSTR optional, out
nSize As UInteger ' DWORD
) As UInteger
End Function' lpAppName : LPCSTR
' lpReturnedString : LPSTR optional, out
' nSize : DWORD
Declare PtrSafe Function GetProfileSectionA Lib "kernel32" ( _
ByVal lpAppName As String, _
ByVal lpReturnedString As String, _
ByVal nSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
GetProfileSectionA = ctypes.windll.kernel32.GetProfileSectionA
GetProfileSectionA.restype = wintypes.DWORD
GetProfileSectionA.argtypes = [
wintypes.LPCSTR, # lpAppName : LPCSTR
wintypes.LPSTR, # lpReturnedString : LPSTR optional, out
wintypes.DWORD, # nSize : DWORD
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
GetProfileSectionA = Fiddle::Function.new(
lib['GetProfileSectionA'],
[
Fiddle::TYPE_VOIDP, # lpAppName : LPCSTR
Fiddle::TYPE_VOIDP, # lpReturnedString : LPSTR optional, out
-Fiddle::TYPE_INT, # nSize : DWORD
],
-Fiddle::TYPE_INT)#[link(name = "kernel32")]
extern "system" {
fn GetProfileSectionA(
lpAppName: *const u8, // LPCSTR
lpReturnedString: *mut u8, // LPSTR optional, out
nSize: u32 // DWORD
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi)]
public static extern uint GetProfileSectionA([MarshalAs(UnmanagedType.LPStr)] string lpAppName, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpReturnedString, uint nSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetProfileSectionA' -Namespace Win32 -PassThru
# $api::GetProfileSectionA(lpAppName, lpReturnedString, nSize)#uselib "KERNEL32.dll"
#func global GetProfileSectionA "GetProfileSectionA" sptr, sptr, sptr
; GetProfileSectionA lpAppName, varptr(lpReturnedString), nSize ; 戻り値は stat
; lpAppName : LPCSTR -> "sptr"
; lpReturnedString : LPSTR optional, out -> "sptr"
; nSize : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll" #cfunc global GetProfileSectionA "GetProfileSectionA" str, var, int ; res = GetProfileSectionA(lpAppName, lpReturnedString, nSize) ; lpAppName : LPCSTR -> "str" ; lpReturnedString : LPSTR optional, out -> "var" ; nSize : DWORD -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll" #cfunc global GetProfileSectionA "GetProfileSectionA" str, sptr, int ; res = GetProfileSectionA(lpAppName, varptr(lpReturnedString), nSize) ; lpAppName : LPCSTR -> "str" ; lpReturnedString : LPSTR optional, out -> "sptr" ; nSize : DWORD -> "int" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; DWORD GetProfileSectionA(LPCSTR lpAppName, LPSTR lpReturnedString, DWORD nSize) #uselib "KERNEL32.dll" #cfunc global GetProfileSectionA "GetProfileSectionA" str, var, int ; res = GetProfileSectionA(lpAppName, lpReturnedString, nSize) ; lpAppName : LPCSTR -> "str" ; lpReturnedString : LPSTR optional, out -> "var" ; nSize : DWORD -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD GetProfileSectionA(LPCSTR lpAppName, LPSTR lpReturnedString, DWORD nSize) #uselib "KERNEL32.dll" #cfunc global GetProfileSectionA "GetProfileSectionA" str, intptr, int ; res = GetProfileSectionA(lpAppName, varptr(lpReturnedString), nSize) ; lpAppName : LPCSTR -> "str" ; lpReturnedString : LPSTR optional, out -> "intptr" ; nSize : DWORD -> "int" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procGetProfileSectionA = kernel32.NewProc("GetProfileSectionA")
)
// lpAppName (LPCSTR), lpReturnedString (LPSTR optional, out), nSize (DWORD)
r1, _, err := procGetProfileSectionA.Call(
uintptr(unsafe.Pointer(windows.BytePtrFromString(lpAppName))),
uintptr(lpReturnedString),
uintptr(nSize),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction GetProfileSectionA(
lpAppName: PAnsiChar; // LPCSTR
lpReturnedString: PAnsiChar; // LPSTR optional, out
nSize: DWORD // DWORD
): DWORD; stdcall;
external 'KERNEL32.dll' name 'GetProfileSectionA';result := DllCall("KERNEL32\GetProfileSectionA"
, "AStr", lpAppName ; LPCSTR
, "Ptr", lpReturnedString ; LPSTR optional, out
, "UInt", nSize ; DWORD
, "UInt") ; return: DWORD●GetProfileSectionA(lpAppName, lpReturnedString, nSize) = DLL("KERNEL32.dll", "dword GetProfileSectionA(char*, char*, dword)")
# 呼び出し: GetProfileSectionA(lpAppName, lpReturnedString, nSize)
# lpAppName : LPCSTR -> "char*"
# lpReturnedString : LPSTR optional, out -> "char*"
# nSize : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn GetProfileSectionA(
lpAppName: [*c]const u8, // LPCSTR
lpReturnedString: [*c]u8, // LPSTR optional, out
nSize: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;proc GetProfileSectionA(
lpAppName: cstring, # LPCSTR
lpReturnedString: ptr char, # LPSTR optional, out
nSize: uint32 # DWORD
): uint32 {.importc: "GetProfileSectionA", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
uint GetProfileSectionA(
const(char)* lpAppName, // LPCSTR
char* lpReturnedString, // LPSTR optional, out
uint nSize // DWORD
);ccall((:GetProfileSectionA, "KERNEL32.dll"), stdcall, UInt32,
(Cstring, Ptr{UInt8}, UInt32),
lpAppName, lpReturnedString, nSize)
# lpAppName : LPCSTR -> Cstring
# lpReturnedString : LPSTR optional, out -> Ptr{UInt8}
# nSize : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t GetProfileSectionA(
const char* lpAppName,
char* lpReturnedString,
uint32_t nSize);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetProfileSectionA(lpAppName, lpReturnedString, nSize)
-- lpAppName : LPCSTR
-- lpReturnedString : LPSTR optional, out
-- nSize : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetProfileSectionA = lib.func('__stdcall', 'GetProfileSectionA', 'uint32_t', ['str', 'char *', 'uint32_t']);
// GetProfileSectionA(lpAppName, lpReturnedString, nSize)
// lpAppName : LPCSTR -> 'str'
// lpReturnedString : LPSTR optional, out -> 'char *'
// nSize : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
GetProfileSectionA: { parameters: ["buffer", "buffer", "u32"], result: "u32" },
});
// lib.symbols.GetProfileSectionA(lpAppName, lpReturnedString, nSize)
// lpAppName : LPCSTR -> "buffer"
// lpReturnedString : LPSTR optional, out -> "buffer"
// nSize : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t GetProfileSectionA(
const char* lpAppName,
char* lpReturnedString,
uint32_t nSize);
C, "KERNEL32.dll");
// $ffi->GetProfileSectionA(lpAppName, lpReturnedString, nSize);
// lpAppName : LPCSTR
// lpReturnedString : LPSTR 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.ASCII_OPTIONS);
int GetProfileSectionA(
String lpAppName, // LPCSTR
byte[] lpReturnedString, // LPSTR optional, out
int nSize // DWORD
);
}@[Link("kernel32")]
lib LibKERNEL32
fun GetProfileSectionA = GetProfileSectionA(
lpAppName : UInt8*, # LPCSTR
lpReturnedString : UInt8*, # LPSTR 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 GetProfileSectionANative = Uint32 Function(Pointer<Utf8>, Pointer<Utf8>, Uint32);
typedef GetProfileSectionADart = int Function(Pointer<Utf8>, Pointer<Utf8>, int);
final GetProfileSectionA = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<GetProfileSectionANative, GetProfileSectionADart>('GetProfileSectionA');
// lpAppName : LPCSTR -> Pointer<Utf8>
// lpReturnedString : LPSTR optional, out -> Pointer<Utf8>
// nSize : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function GetProfileSectionA(
lpAppName: PAnsiChar; // LPCSTR
lpReturnedString: PAnsiChar; // LPSTR optional, out
nSize: DWORD // DWORD
): DWORD; stdcall;
external 'KERNEL32.dll' name 'GetProfileSectionA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "GetProfileSectionA"
c_GetProfileSectionA :: CString -> CString -> Word32 -> IO Word32
-- lpAppName : LPCSTR -> CString
-- lpReturnedString : LPSTR optional, out -> CString
-- nSize : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let getprofilesectiona =
foreign "GetProfileSectionA"
(string @-> string @-> uint32_t @-> returning uint32_t)
(* lpAppName : LPCSTR -> string *)
(* lpReturnedString : LPSTR optional, out -> string *)
(* 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 ("GetProfileSectionA" get-profile-section-a :convention :stdcall) :uint32
(lp-app-name :string) ; LPCSTR
(lp-returned-string :pointer) ; LPSTR optional, out
(n-size :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $GetProfileSectionA = Win32::API::More->new('KERNEL32',
'DWORD GetProfileSectionA(LPCSTR lpAppName, LPSTR lpReturnedString, DWORD nSize)');
# my $ret = $GetProfileSectionA->Call($lpAppName, $lpReturnedString, $nSize);
# lpAppName : LPCSTR -> LPCSTR
# lpReturnedString : LPSTR optional, out -> LPSTR
# nSize : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f GetProfileSectionW (Unicode版) — win.iniの指定セクション全体をUnicodeで取得する旧式関数。
- f WriteProfileSectionA — win.iniの指定セクション全体をANSIで書き込む旧式関数。