Win32 API 日本語リファレンス
ホームStorage.OfflineFiles › OfflineFilesQueryStatusEx

OfflineFilesQueryStatusEx

関数
オフラインファイルの動作中・有効・利用可能状態を照会する。
DLLCSCAPI.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD OfflineFilesQueryStatusEx(
    BOOL* pbActive,   // optional
    BOOL* pbEnabled,   // optional
    BOOL* pbAvailable   // optional
);

パラメーター

名前方向説明
pbActiveBOOL*outoptionalオフラインファイル機能が現在動作中かを示すBOOLを受け取る出力ポインタ。
pbEnabledBOOL*outoptional機能が有効に設定されているかを示すBOOLを受け取る出力ポインタ。
pbAvailableBOOL*outoptionalこの環境でオフラインファイル機能が利用可能かを示すBOOLを受け取る出力ポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD OfflineFilesQueryStatusEx(
    BOOL* pbActive,   // optional
    BOOL* pbEnabled,   // optional
    BOOL* pbAvailable   // optional
);
[DllImport("CSCAPI.dll", ExactSpelling = true)]
static extern uint OfflineFilesQueryStatusEx(
    IntPtr pbActive,   // BOOL* optional, out
    IntPtr pbEnabled,   // BOOL* optional, out
    IntPtr pbAvailable   // BOOL* optional, out
);
<DllImport("CSCAPI.dll", ExactSpelling:=True)>
Public Shared Function OfflineFilesQueryStatusEx(
    pbActive As IntPtr,   ' BOOL* optional, out
    pbEnabled As IntPtr,   ' BOOL* optional, out
    pbAvailable As IntPtr   ' BOOL* optional, out
) As UInteger
End Function
' pbActive : BOOL* optional, out
' pbEnabled : BOOL* optional, out
' pbAvailable : BOOL* optional, out
Declare PtrSafe Function OfflineFilesQueryStatusEx Lib "cscapi" ( _
    ByVal pbActive As LongPtr, _
    ByVal pbEnabled As LongPtr, _
    ByVal pbAvailable As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

OfflineFilesQueryStatusEx = ctypes.windll.cscapi.OfflineFilesQueryStatusEx
OfflineFilesQueryStatusEx.restype = wintypes.DWORD
OfflineFilesQueryStatusEx.argtypes = [
    ctypes.c_void_p,  # pbActive : BOOL* optional, out
    ctypes.c_void_p,  # pbEnabled : BOOL* optional, out
    ctypes.c_void_p,  # pbAvailable : BOOL* optional, out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	cscapi = windows.NewLazySystemDLL("CSCAPI.dll")
	procOfflineFilesQueryStatusEx = cscapi.NewProc("OfflineFilesQueryStatusEx")
)

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

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

typedef OfflineFilesQueryStatusExNative = Uint32 Function(Pointer<Int32>, Pointer<Int32>, Pointer<Int32>);
typedef OfflineFilesQueryStatusExDart = int Function(Pointer<Int32>, Pointer<Int32>, Pointer<Int32>);
final OfflineFilesQueryStatusEx = DynamicLibrary.open('CSCAPI.dll')
    .lookupFunction<OfflineFilesQueryStatusExNative, OfflineFilesQueryStatusExDart>('OfflineFilesQueryStatusEx');
// pbActive : BOOL* optional, out -> Pointer<Int32>
// pbEnabled : BOOL* optional, out -> Pointer<Int32>
// pbAvailable : BOOL* optional, out -> Pointer<Int32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function OfflineFilesQueryStatusEx(
  pbActive: Pointer;   // BOOL* optional, out
  pbEnabled: Pointer;   // BOOL* optional, out
  pbAvailable: Pointer   // BOOL* optional, out
): DWORD; stdcall;
  external 'CSCAPI.dll' name 'OfflineFilesQueryStatusEx';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "OfflineFilesQueryStatusEx"
  c_OfflineFilesQueryStatusEx :: Ptr CInt -> Ptr CInt -> Ptr CInt -> IO Word32
-- pbActive : BOOL* optional, out -> Ptr CInt
-- pbEnabled : BOOL* optional, out -> Ptr CInt
-- pbAvailable : BOOL* optional, out -> Ptr CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let offlinefilesquerystatusex =
  foreign "OfflineFilesQueryStatusEx"
    ((ptr int32_t) @-> (ptr int32_t) @-> (ptr int32_t) @-> returning uint32_t)
(* pbActive : BOOL* optional, out -> (ptr int32_t) *)
(* pbEnabled : BOOL* optional, out -> (ptr int32_t) *)
(* pbAvailable : BOOL* optional, out -> (ptr int32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library cscapi (t "CSCAPI.dll"))
(cffi:use-foreign-library cscapi)

(cffi:defcfun ("OfflineFilesQueryStatusEx" offline-files-query-status-ex :convention :stdcall) :uint32
  (pb-active :pointer)   ; BOOL* optional, out
  (pb-enabled :pointer)   ; BOOL* optional, out
  (pb-available :pointer))   ; BOOL* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $OfflineFilesQueryStatusEx = Win32::API::More->new('CSCAPI',
    'DWORD OfflineFilesQueryStatusEx(LPVOID pbActive, LPVOID pbEnabled, LPVOID pbAvailable)');
# my $ret = $OfflineFilesQueryStatusEx->Call($pbActive, $pbEnabled, $pbAvailable);
# pbActive : BOOL* optional, out -> LPVOID
# pbEnabled : BOOL* optional, out -> LPVOID
# pbAvailable : BOOL* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API