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

GetPrivateProfileStructA

関数
iniファイルからチェックサム付き構造体データをANSIで取得する。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

BOOL GetPrivateProfileStructA(
    LPCSTR lpszSection,
    LPCSTR lpszKey,
    void* lpStruct,   // optional
    DWORD uSizeStruct,
    LPCSTR szFile   // optional
);

パラメーター

名前方向説明
lpszSectionLPCSTRin読み取り対象のセクション名を指す。
lpszKeyLPCSTRin読み取り対象のキー名を指す。
lpStructvoid*outoptional取得した構造体データを受け取るバッファへのポインタ。
uSizeStructDWORDinlpStructが指すバッファのサイズをバイト単位で指定する。
szFileLPCSTRinoptional対象INIファイルのパス。データはチェックサム付きで格納されている。

戻り値の型: BOOL

各言語での呼び出し定義

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

BOOL GetPrivateProfileStructA(
    LPCSTR lpszSection,
    LPCSTR lpszKey,
    void* lpStruct,   // optional
    DWORD uSizeStruct,
    LPCSTR szFile   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool GetPrivateProfileStructA(
    [MarshalAs(UnmanagedType.LPStr)] string lpszSection,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string lpszKey,   // LPCSTR
    IntPtr lpStruct,   // void* optional, out
    uint uSizeStruct,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string szFile   // LPCSTR optional
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function GetPrivateProfileStructA(
    <MarshalAs(UnmanagedType.LPStr)> lpszSection As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpszKey As String,   ' LPCSTR
    lpStruct As IntPtr,   ' void* optional, out
    uSizeStruct As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> szFile As String   ' LPCSTR optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpszSection : LPCSTR
' lpszKey : LPCSTR
' lpStruct : void* optional, out
' uSizeStruct : DWORD
' szFile : LPCSTR optional
Declare PtrSafe Function GetPrivateProfileStructA Lib "kernel32" ( _
    ByVal lpszSection As String, _
    ByVal lpszKey As String, _
    ByVal lpStruct As LongPtr, _
    ByVal uSizeStruct As Long, _
    ByVal szFile As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetPrivateProfileStructA = ctypes.windll.kernel32.GetPrivateProfileStructA
GetPrivateProfileStructA.restype = wintypes.BOOL
GetPrivateProfileStructA.argtypes = [
    wintypes.LPCSTR,  # lpszSection : LPCSTR
    wintypes.LPCSTR,  # lpszKey : LPCSTR
    ctypes.POINTER(None),  # lpStruct : void* optional, out
    wintypes.DWORD,  # uSizeStruct : DWORD
    wintypes.LPCSTR,  # szFile : LPCSTR optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetPrivateProfileStructA = Fiddle::Function.new(
  lib['GetPrivateProfileStructA'],
  [
    Fiddle::TYPE_VOIDP,  # lpszSection : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpszKey : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpStruct : void* optional, out
    -Fiddle::TYPE_INT,  # uSizeStruct : DWORD
    Fiddle::TYPE_VOIDP,  # szFile : LPCSTR optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn GetPrivateProfileStructA(
        lpszSection: *const u8,  // LPCSTR
        lpszKey: *const u8,  // LPCSTR
        lpStruct: *mut (),  // void* optional, out
        uSizeStruct: u32,  // DWORD
        szFile: *const u8  // LPCSTR optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi)]
public static extern bool GetPrivateProfileStructA([MarshalAs(UnmanagedType.LPStr)] string lpszSection, [MarshalAs(UnmanagedType.LPStr)] string lpszKey, IntPtr lpStruct, uint uSizeStruct, [MarshalAs(UnmanagedType.LPStr)] string szFile);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetPrivateProfileStructA' -Namespace Win32 -PassThru
# $api::GetPrivateProfileStructA(lpszSection, lpszKey, lpStruct, uSizeStruct, szFile)
#uselib "KERNEL32.dll"
#func global GetPrivateProfileStructA "GetPrivateProfileStructA" sptr, sptr, sptr, sptr, sptr
; GetPrivateProfileStructA lpszSection, lpszKey, lpStruct, uSizeStruct, szFile   ; 戻り値は stat
; lpszSection : LPCSTR -> "sptr"
; lpszKey : LPCSTR -> "sptr"
; lpStruct : void* optional, out -> "sptr"
; uSizeStruct : DWORD -> "sptr"
; szFile : LPCSTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global GetPrivateProfileStructA "GetPrivateProfileStructA" str, str, sptr, int, str
; res = GetPrivateProfileStructA(lpszSection, lpszKey, lpStruct, uSizeStruct, szFile)
; lpszSection : LPCSTR -> "str"
; lpszKey : LPCSTR -> "str"
; lpStruct : void* optional, out -> "sptr"
; uSizeStruct : DWORD -> "int"
; szFile : LPCSTR optional -> "str"
; BOOL GetPrivateProfileStructA(LPCSTR lpszSection, LPCSTR lpszKey, void* lpStruct, DWORD uSizeStruct, LPCSTR szFile)
#uselib "KERNEL32.dll"
#cfunc global GetPrivateProfileStructA "GetPrivateProfileStructA" str, str, intptr, int, str
; res = GetPrivateProfileStructA(lpszSection, lpszKey, lpStruct, uSizeStruct, szFile)
; lpszSection : LPCSTR -> "str"
; lpszKey : LPCSTR -> "str"
; lpStruct : void* optional, out -> "intptr"
; uSizeStruct : DWORD -> "int"
; szFile : LPCSTR optional -> "str"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetPrivateProfileStructA = kernel32.NewProc("GetPrivateProfileStructA")
)

// lpszSection (LPCSTR), lpszKey (LPCSTR), lpStruct (void* optional, out), uSizeStruct (DWORD), szFile (LPCSTR optional)
r1, _, err := procGetPrivateProfileStructA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpszSection))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpszKey))),
	uintptr(lpStruct),
	uintptr(uSizeStruct),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(szFile))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function GetPrivateProfileStructA(
  lpszSection: PAnsiChar;   // LPCSTR
  lpszKey: PAnsiChar;   // LPCSTR
  lpStruct: Pointer;   // void* optional, out
  uSizeStruct: DWORD;   // DWORD
  szFile: PAnsiChar   // LPCSTR optional
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetPrivateProfileStructA';
result := DllCall("KERNEL32\GetPrivateProfileStructA"
    , "AStr", lpszSection   ; LPCSTR
    , "AStr", lpszKey   ; LPCSTR
    , "Ptr", lpStruct   ; void* optional, out
    , "UInt", uSizeStruct   ; DWORD
    , "AStr", szFile   ; LPCSTR optional
    , "Int")   ; return: BOOL
●GetPrivateProfileStructA(lpszSection, lpszKey, lpStruct, uSizeStruct, szFile) = DLL("KERNEL32.dll", "bool GetPrivateProfileStructA(char*, char*, void*, dword, char*)")
# 呼び出し: GetPrivateProfileStructA(lpszSection, lpszKey, lpStruct, uSizeStruct, szFile)
# lpszSection : LPCSTR -> "char*"
# lpszKey : LPCSTR -> "char*"
# lpStruct : void* optional, out -> "void*"
# uSizeStruct : DWORD -> "dword"
# szFile : LPCSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn GetPrivateProfileStructA(
    lpszSection: [*c]const u8, // LPCSTR
    lpszKey: [*c]const u8, // LPCSTR
    lpStruct: ?*anyopaque, // void* optional, out
    uSizeStruct: u32, // DWORD
    szFile: [*c]const u8 // LPCSTR optional
) callconv(std.os.windows.WINAPI) i32;
proc GetPrivateProfileStructA(
    lpszSection: cstring,  # LPCSTR
    lpszKey: cstring,  # LPCSTR
    lpStruct: pointer,  # void* optional, out
    uSizeStruct: uint32,  # DWORD
    szFile: cstring  # LPCSTR optional
): int32 {.importc: "GetPrivateProfileStructA", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int GetPrivateProfileStructA(
    const(char)* lpszSection,   // LPCSTR
    const(char)* lpszKey,   // LPCSTR
    void* lpStruct,   // void* optional, out
    uint uSizeStruct,   // DWORD
    const(char)* szFile   // LPCSTR optional
);
ccall((:GetPrivateProfileStructA, "KERNEL32.dll"), stdcall, Int32,
      (Cstring, Cstring, Ptr{Cvoid}, UInt32, Cstring),
      lpszSection, lpszKey, lpStruct, uSizeStruct, szFile)
# lpszSection : LPCSTR -> Cstring
# lpszKey : LPCSTR -> Cstring
# lpStruct : void* optional, out -> Ptr{Cvoid}
# uSizeStruct : DWORD -> UInt32
# szFile : LPCSTR optional -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetPrivateProfileStructA(
    const char* lpszSection,
    const char* lpszKey,
    void* lpStruct,
    uint32_t uSizeStruct,
    const char* szFile);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetPrivateProfileStructA(lpszSection, lpszKey, lpStruct, uSizeStruct, szFile)
-- lpszSection : LPCSTR
-- lpszKey : LPCSTR
-- lpStruct : void* optional, out
-- uSizeStruct : DWORD
-- szFile : LPCSTR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetPrivateProfileStructA = lib.func('__stdcall', 'GetPrivateProfileStructA', 'int32_t', ['str', 'str', 'void *', 'uint32_t', 'str']);
// GetPrivateProfileStructA(lpszSection, lpszKey, lpStruct, uSizeStruct, szFile)
// lpszSection : LPCSTR -> 'str'
// lpszKey : LPCSTR -> 'str'
// lpStruct : void* optional, out -> 'void *'
// uSizeStruct : DWORD -> 'uint32_t'
// szFile : LPCSTR optional -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GetPrivateProfileStructA: { parameters: ["buffer", "buffer", "pointer", "u32", "buffer"], result: "i32" },
});
// lib.symbols.GetPrivateProfileStructA(lpszSection, lpszKey, lpStruct, uSizeStruct, szFile)
// lpszSection : LPCSTR -> "buffer"
// lpszKey : LPCSTR -> "buffer"
// lpStruct : void* optional, out -> "pointer"
// uSizeStruct : DWORD -> "u32"
// szFile : LPCSTR optional -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetPrivateProfileStructA(
    const char* lpszSection,
    const char* lpszKey,
    void* lpStruct,
    uint32_t uSizeStruct,
    const char* szFile);
C, "KERNEL32.dll");
// $ffi->GetPrivateProfileStructA(lpszSection, lpszKey, lpStruct, uSizeStruct, szFile);
// lpszSection : LPCSTR
// lpszKey : LPCSTR
// lpStruct : void* optional, out
// uSizeStruct : DWORD
// szFile : LPCSTR optional
// 構造体/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);
    boolean GetPrivateProfileStructA(
        String lpszSection,   // LPCSTR
        String lpszKey,   // LPCSTR
        Pointer lpStruct,   // void* optional, out
        int uSizeStruct,   // DWORD
        String szFile   // LPCSTR optional
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun GetPrivateProfileStructA = GetPrivateProfileStructA(
    lpszSection : UInt8*,   # LPCSTR
    lpszKey : UInt8*,   # LPCSTR
    lpStruct : Void*,   # void* optional, out
    uSizeStruct : UInt32,   # DWORD
    szFile : UInt8*   # LPCSTR optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetPrivateProfileStructANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Void>, Uint32, Pointer<Utf8>);
typedef GetPrivateProfileStructADart = int Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Void>, int, Pointer<Utf8>);
final GetPrivateProfileStructA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetPrivateProfileStructANative, GetPrivateProfileStructADart>('GetPrivateProfileStructA');
// lpszSection : LPCSTR -> Pointer<Utf8>
// lpszKey : LPCSTR -> Pointer<Utf8>
// lpStruct : void* optional, out -> Pointer<Void>
// uSizeStruct : DWORD -> Uint32
// szFile : LPCSTR optional -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetPrivateProfileStructA(
  lpszSection: PAnsiChar;   // LPCSTR
  lpszKey: PAnsiChar;   // LPCSTR
  lpStruct: Pointer;   // void* optional, out
  uSizeStruct: DWORD;   // DWORD
  szFile: PAnsiChar   // LPCSTR optional
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetPrivateProfileStructA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetPrivateProfileStructA"
  c_GetPrivateProfileStructA :: CString -> CString -> Ptr () -> Word32 -> CString -> IO CInt
-- lpszSection : LPCSTR -> CString
-- lpszKey : LPCSTR -> CString
-- lpStruct : void* optional, out -> Ptr ()
-- uSizeStruct : DWORD -> Word32
-- szFile : LPCSTR optional -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getprivateprofilestructa =
  foreign "GetPrivateProfileStructA"
    (string @-> string @-> (ptr void) @-> uint32_t @-> string @-> returning int32_t)
(* lpszSection : LPCSTR -> string *)
(* lpszKey : LPCSTR -> string *)
(* lpStruct : void* optional, out -> (ptr void) *)
(* uSizeStruct : DWORD -> uint32_t *)
(* szFile : LPCSTR optional -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("GetPrivateProfileStructA" get-private-profile-struct-a :convention :stdcall) :int32
  (lpsz-section :string)   ; LPCSTR
  (lpsz-key :string)   ; LPCSTR
  (lp-struct :pointer)   ; void* optional, out
  (u-size-struct :uint32)   ; DWORD
  (sz-file :string))   ; LPCSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetPrivateProfileStructA = Win32::API::More->new('KERNEL32',
    'BOOL GetPrivateProfileStructA(LPCSTR lpszSection, LPCSTR lpszKey, LPVOID lpStruct, DWORD uSizeStruct, LPCSTR szFile)');
# my $ret = $GetPrivateProfileStructA->Call($lpszSection, $lpszKey, $lpStruct, $uSizeStruct, $szFile);
# lpszSection : LPCSTR -> LPCSTR
# lpszKey : LPCSTR -> LPCSTR
# lpStruct : void* optional, out -> LPVOID
# uSizeStruct : DWORD -> DWORD
# szFile : LPCSTR optional -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い