Win32 API 日本語リファレンス
ホームUI.Shell › ReadCabinetState

ReadCabinetState

関数
エクスプローラーのキャビネット状態設定を読み込む。
DLLSHELL32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

// SHELL32.dll
#include <windows.h>

BOOL ReadCabinetState(
    CABINETSTATE* pcs,
    INT cLength
);

パラメーター

名前方向説明
pcsCABINETSTATE*outこの関数が返るとき、レジストリから取得された情報または既定の情報のいずれかを格納する CABINETSTATE 構造体へのポインターを格納します。
cLengthINTinpcs が指す構造体のサイズ(バイト単位)。

戻り値の型: BOOL

公式ドキュメント

ReadCabinetState は変更されるか、利用できなくなる可能性があります。

戻り値

型: BOOL

返された構造体がレジストリからの情報を格納している場合は TRUE を返します。構造体が既定の情報を格納している場合は FALSE を返します。

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

各言語での呼び出し定義

// SHELL32.dll
#include <windows.h>

BOOL ReadCabinetState(
    CABINETSTATE* pcs,
    INT cLength
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern bool ReadCabinetState(
    IntPtr pcs,   // CABINETSTATE* out
    int cLength   // INT
);
<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function ReadCabinetState(
    pcs As IntPtr,   ' CABINETSTATE* out
    cLength As Integer   ' INT
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pcs : CABINETSTATE* out
' cLength : INT
Declare PtrSafe Function ReadCabinetState Lib "shell32" ( _
    ByVal pcs As LongPtr, _
    ByVal cLength As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ReadCabinetState = ctypes.windll.shell32.ReadCabinetState
ReadCabinetState.restype = wintypes.BOOL
ReadCabinetState.argtypes = [
    ctypes.c_void_p,  # pcs : CABINETSTATE* out
    ctypes.c_int,  # cLength : INT
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
ReadCabinetState = Fiddle::Function.new(
  lib['ReadCabinetState'],
  [
    Fiddle::TYPE_VOIDP,  # pcs : CABINETSTATE* out
    Fiddle::TYPE_INT,  # cLength : INT
  ],
  Fiddle::TYPE_INT)
#[link(name = "shell32")]
extern "system" {
    fn ReadCabinetState(
        pcs: *mut CABINETSTATE,  // CABINETSTATE* out
        cLength: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHELL32.dll")]
public static extern bool ReadCabinetState(IntPtr pcs, int cLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_ReadCabinetState' -Namespace Win32 -PassThru
# $api::ReadCabinetState(pcs, cLength)
#uselib "SHELL32.dll"
#func global ReadCabinetState "ReadCabinetState" sptr, sptr
; ReadCabinetState varptr(pcs), cLength   ; 戻り値は stat
; pcs : CABINETSTATE* out -> "sptr"
; cLength : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHELL32.dll"
#cfunc global ReadCabinetState "ReadCabinetState" var, int
; res = ReadCabinetState(pcs, cLength)
; pcs : CABINETSTATE* out -> "var"
; cLength : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL ReadCabinetState(CABINETSTATE* pcs, INT cLength)
#uselib "SHELL32.dll"
#cfunc global ReadCabinetState "ReadCabinetState" var, int
; res = ReadCabinetState(pcs, cLength)
; pcs : CABINETSTATE* out -> "var"
; cLength : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procReadCabinetState = shell32.NewProc("ReadCabinetState")
)

// pcs (CABINETSTATE* out), cLength (INT)
r1, _, err := procReadCabinetState.Call(
	uintptr(pcs),
	uintptr(cLength),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function ReadCabinetState(
  pcs: Pointer;   // CABINETSTATE* out
  cLength: Integer   // INT
): BOOL; stdcall;
  external 'SHELL32.dll' name 'ReadCabinetState';
result := DllCall("SHELL32\ReadCabinetState"
    , "Ptr", pcs   ; CABINETSTATE* out
    , "Int", cLength   ; INT
    , "Int")   ; return: BOOL
●ReadCabinetState(pcs, cLength) = DLL("SHELL32.dll", "bool ReadCabinetState(void*, int)")
# 呼び出し: ReadCabinetState(pcs, cLength)
# pcs : CABINETSTATE* out -> "void*"
# cLength : INT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "shell32" fn ReadCabinetState(
    pcs: [*c]CABINETSTATE, // CABINETSTATE* out
    cLength: i32 // INT
) callconv(std.os.windows.WINAPI) i32;
proc ReadCabinetState(
    pcs: ptr CABINETSTATE,  # CABINETSTATE* out
    cLength: int32  # INT
): int32 {.importc: "ReadCabinetState", stdcall, dynlib: "SHELL32.dll".}
pragma(lib, "shell32");
extern(Windows)
int ReadCabinetState(
    CABINETSTATE* pcs,   // CABINETSTATE* out
    int cLength   // INT
);
ccall((:ReadCabinetState, "SHELL32.dll"), stdcall, Int32,
      (Ptr{CABINETSTATE}, Int32),
      pcs, cLength)
# pcs : CABINETSTATE* out -> Ptr{CABINETSTATE}
# cLength : INT -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t ReadCabinetState(
    void* pcs,
    int32_t cLength);
]]
local shell32 = ffi.load("shell32")
-- shell32.ReadCabinetState(pcs, cLength)
-- pcs : CABINETSTATE* out
-- cLength : INT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHELL32.dll');
const ReadCabinetState = lib.func('__stdcall', 'ReadCabinetState', 'int32_t', ['void *', 'int32_t']);
// ReadCabinetState(pcs, cLength)
// pcs : CABINETSTATE* out -> 'void *'
// cLength : INT -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHELL32.dll", {
  ReadCabinetState: { parameters: ["pointer", "i32"], result: "i32" },
});
// lib.symbols.ReadCabinetState(pcs, cLength)
// pcs : CABINETSTATE* out -> "pointer"
// cLength : INT -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t ReadCabinetState(
    void* pcs,
    int32_t cLength);
C, "SHELL32.dll");
// $ffi->ReadCabinetState(pcs, cLength);
// pcs : CABINETSTATE* out
// cLength : 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 Shell32 extends StdCallLibrary {
    Shell32 INSTANCE = Native.load("shell32", Shell32.class);
    boolean ReadCabinetState(
        Pointer pcs,   // CABINETSTATE* out
        int cLength   // INT
    );
}
@[Link("shell32")]
lib LibSHELL32
  fun ReadCabinetState = ReadCabinetState(
    pcs : CABINETSTATE*,   # CABINETSTATE* out
    cLength : Int32   # INT
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef ReadCabinetStateNative = Int32 Function(Pointer<Void>, Int32);
typedef ReadCabinetStateDart = int Function(Pointer<Void>, int);
final ReadCabinetState = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<ReadCabinetStateNative, ReadCabinetStateDart>('ReadCabinetState');
// pcs : CABINETSTATE* out -> Pointer<Void>
// cLength : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ReadCabinetState(
  pcs: Pointer;   // CABINETSTATE* out
  cLength: Integer   // INT
): BOOL; stdcall;
  external 'SHELL32.dll' name 'ReadCabinetState';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ReadCabinetState"
  c_ReadCabinetState :: Ptr () -> Int32 -> IO CInt
-- pcs : CABINETSTATE* out -> Ptr ()
-- cLength : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let readcabinetstate =
  foreign "ReadCabinetState"
    ((ptr void) @-> int32_t @-> returning int32_t)
(* pcs : CABINETSTATE* out -> (ptr void) *)
(* cLength : INT -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)

(cffi:defcfun ("ReadCabinetState" read-cabinet-state :convention :stdcall) :int32
  (pcs :pointer)   ; CABINETSTATE* out
  (c-length :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ReadCabinetState = Win32::API::More->new('SHELL32',
    'BOOL ReadCabinetState(LPVOID pcs, int cLength)');
# my $ret = $ReadCabinetState->Call($pcs, $cLength);
# pcs : CABINETSTATE* out -> LPVOID
# cLength : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型