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

WriteCabinetState

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

シグネチャ

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

BOOL WriteCabinetState(
    CABINETSTATE* pcs
);

パラメーター

名前方向説明
pcsCABINETSTATE*in設定する値を保持する CABINETSTATE 構造体へのポインターです。

戻り値の型: BOOL

公式ドキュメント

WriteCabinetState は変更または利用できなくなる可能性があります。

戻り値

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

WriteCabinetState = ctypes.windll.shell32.WriteCabinetState
WriteCabinetState.restype = wintypes.BOOL
WriteCabinetState.argtypes = [
    ctypes.c_void_p,  # pcs : CABINETSTATE*
]
require 'fiddle'
require 'fiddle/import'

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

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procWriteCabinetState = shell32.NewProc("WriteCabinetState")
)

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

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

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

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

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

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

関連項目

使用する型