Win32 API 日本語リファレンス
ホームDevices.Display › GetAutoRotationState

GetAutoRotationState

関数
デバイスの画面自動回転の状態を取得する。
DLLUSER32.dll呼出規約winapi

シグネチャ

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

BOOL GetAutoRotationState(
    AR_STATE* pState
);

パラメーター

名前方向説明
pStateAR_STATE*outシステムの現在の自動回転状態を受け取るメモリ位置へのポインター。

戻り値の型: BOOL

公式ドキュメント

システムの画面自動回転の状態を表す AR_STATE 値を取得します。たとえば、自動回転がサポートされているかどうか、およびユーザーによって有効化されているかどうかを取得できます。

戻り値

メソッドが成功した場合は TRUE、それ以外の場合は FALSE。

この関数の使用例については、GetDisplayAutoRotationPreferences を参照してください。

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

各言語での呼び出し定義

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

BOOL GetAutoRotationState(
    AR_STATE* pState
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", ExactSpelling = true)]
static extern bool GetAutoRotationState(
    out int pState   // AR_STATE* out
);
<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function GetAutoRotationState(
    <Out> ByRef pState As Integer   ' AR_STATE* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pState : AR_STATE* out
Declare PtrSafe Function GetAutoRotationState Lib "user32" ( _
    ByRef pState As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetAutoRotationState = ctypes.windll.user32.GetAutoRotationState
GetAutoRotationState.restype = wintypes.BOOL
GetAutoRotationState.argtypes = [
    ctypes.c_void_p,  # pState : AR_STATE* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procGetAutoRotationState = user32.NewProc("GetAutoRotationState")
)

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

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

typedef GetAutoRotationStateNative = Int32 Function(Pointer<Int32>);
typedef GetAutoRotationStateDart = int Function(Pointer<Int32>);
final GetAutoRotationState = DynamicLibrary.open('USER32.dll')
    .lookupFunction<GetAutoRotationStateNative, GetAutoRotationStateDart>('GetAutoRotationState');
// pState : AR_STATE* out -> Pointer<Int32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetAutoRotationState(
  pState: Pointer   // AR_STATE* out
): BOOL; stdcall;
  external 'USER32.dll' name 'GetAutoRotationState';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let getautorotationstate =
  foreign "GetAutoRotationState"
    ((ptr int32_t) @-> returning int32_t)
(* pState : AR_STATE* out -> (ptr int32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

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

関連項目

使用する型