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

SHIsFileAvailableOffline

関数
ファイルがオフラインで利用可能かどうかを判定する。
DLLSHELL32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT SHIsFileAvailableOffline(
    LPCWSTR pwszPath,
    DWORD* pdwStatus   // optional
);

パラメーター

名前方向説明
pwszPathLPCWSTRinネットワーク上のファイルまたはディレクトリへのフルパスを指定する文字列値へのポインターです。このパスは UNC 形式である必要はありません。pszPath がネットワーク パスでない場合、関数は E_INVALIDARG を返します。
pdwStatusDWORD*outoptional

関数が成功した場合に、以下のフラグのうち 1 つ以上を受け取る DWORD 型の変数へのポインターです。

OFFLINE_STATUS_LOCAL (0x01)

ファイルが開かれている場合、キャッシュ内で開かれています。

OFFLINE_STATUS_REMOTE (0x02)

ファイルが開かれている場合、サーバー上で開かれています。

OFFLINE_STATUS_INCOMPLETE (0x04)

ローカル コピーは現在不完全です。同期が完了するまで、このファイルをオフライン モードで開くことはできません。

戻り値の型: HRESULT

公式ドキュメント

ファイルまたはフォルダーがオフラインで使用できるかどうかを判定します。この関数は、ファイルがネットワークから開かれるのか、ローカルのオフライン ファイル キャッシュから開かれるのか、あるいは両方の場所から開かれるのかも判定します。

戻り値

型: HRESULT

この関数は以下のいずれかの値を返すことがあります。

戻り値 説明
S_OK
ファイルまたはディレクトリはキャッシュされています。OFFLINE_STATUS_INCOMPLETE が設定されていない限り、オフラインで使用できます。
E_INVALIDARG
パスが無効であるか、ネットワーク パスではありません。ファイルまたはディレクトリはキャッシュされていません。
E_FAIL
ファイルまたはディレクトリはキャッシュされていません。

解説(Remarks)

pszPath がディレクトリの場合、SHIsFileAvailableOfflineOFFLINE_STATUS_INCOMPLETE フラグを返しません。

SHIsFileAvailableOfflineOFFLINE_STATUS_LOCALOFFLINE_STATUS_REMOTE の両方を返した場合、そのファイルまたはディレクトリは両方の場所で開かれています。これはサーバーがオンラインのときによく発生します。

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

各言語での呼び出し定義

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

HRESULT SHIsFileAvailableOffline(
    LPCWSTR pwszPath,
    DWORD* pdwStatus   // optional
);
[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern int SHIsFileAvailableOffline(
    [MarshalAs(UnmanagedType.LPWStr)] string pwszPath,   // LPCWSTR
    IntPtr pdwStatus   // DWORD* optional, out
);
<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function SHIsFileAvailableOffline(
    <MarshalAs(UnmanagedType.LPWStr)> pwszPath As String,   ' LPCWSTR
    pdwStatus As IntPtr   ' DWORD* optional, out
) As Integer
End Function
' pwszPath : LPCWSTR
' pdwStatus : DWORD* optional, out
Declare PtrSafe Function SHIsFileAvailableOffline Lib "shell32" ( _
    ByVal pwszPath As LongPtr, _
    ByVal pdwStatus As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SHIsFileAvailableOffline = ctypes.windll.shell32.SHIsFileAvailableOffline
SHIsFileAvailableOffline.restype = ctypes.c_int
SHIsFileAvailableOffline.argtypes = [
    wintypes.LPCWSTR,  # pwszPath : LPCWSTR
    ctypes.POINTER(wintypes.DWORD),  # pdwStatus : DWORD* optional, out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHIsFileAvailableOffline = shell32.NewProc("SHIsFileAvailableOffline")
)

// pwszPath (LPCWSTR), pdwStatus (DWORD* optional, out)
r1, _, err := procSHIsFileAvailableOffline.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pwszPath))),
	uintptr(pdwStatus),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function SHIsFileAvailableOffline(
  pwszPath: PWideChar;   // LPCWSTR
  pdwStatus: Pointer   // DWORD* optional, out
): Integer; stdcall;
  external 'SHELL32.dll' name 'SHIsFileAvailableOffline';
result := DllCall("SHELL32\SHIsFileAvailableOffline"
    , "WStr", pwszPath   ; LPCWSTR
    , "Ptr", pdwStatus   ; DWORD* optional, out
    , "Int")   ; return: HRESULT
●SHIsFileAvailableOffline(pwszPath, pdwStatus) = DLL("SHELL32.dll", "int SHIsFileAvailableOffline(char*, void*)")
# 呼び出し: SHIsFileAvailableOffline(pwszPath, pdwStatus)
# pwszPath : LPCWSTR -> "char*"
# pdwStatus : DWORD* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef SHIsFileAvailableOfflineNative = Int32 Function(Pointer<Utf16>, Pointer<Uint32>);
typedef SHIsFileAvailableOfflineDart = int Function(Pointer<Utf16>, Pointer<Uint32>);
final SHIsFileAvailableOffline = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<SHIsFileAvailableOfflineNative, SHIsFileAvailableOfflineDart>('SHIsFileAvailableOffline');
// pwszPath : LPCWSTR -> Pointer<Utf16>
// pdwStatus : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHIsFileAvailableOffline(
  pwszPath: PWideChar;   // LPCWSTR
  pdwStatus: Pointer   // DWORD* optional, out
): Integer; stdcall;
  external 'SHELL32.dll' name 'SHIsFileAvailableOffline';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHIsFileAvailableOffline"
  c_SHIsFileAvailableOffline :: CWString -> Ptr Word32 -> IO Int32
-- pwszPath : LPCWSTR -> CWString
-- pdwStatus : DWORD* optional, out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shisfileavailableoffline =
  foreign "SHIsFileAvailableOffline"
    ((ptr uint16_t) @-> (ptr uint32_t) @-> returning int32_t)
(* pwszPath : LPCWSTR -> (ptr uint16_t) *)
(* pdwStatus : DWORD* optional, out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)

(cffi:defcfun ("SHIsFileAvailableOffline" shis-file-available-offline :convention :stdcall) :int32
  (pwsz-path (:string :encoding :utf-16le))   ; LPCWSTR
  (pdw-status :pointer))   ; DWORD* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHIsFileAvailableOffline = Win32::API::More->new('SHELL32',
    'int SHIsFileAvailableOffline(LPCWSTR pwszPath, LPVOID pdwStatus)');
# my $ret = $SHIsFileAvailableOffline->Call($pwszPath, $pdwStatus);
# pwszPath : LPCWSTR -> LPCWSTR
# pdwStatus : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。