SHIsFileAvailableOffline 関数 (shellapi.h)

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

構文

SHSTDAPI SHIsFileAvailableOffline(
  [in]            PCWSTR pwszPath,
  [out, optional] DWORD  *pdwStatus
);

[in] pwszPath

種類: PCWSTR

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

[out, optional] pdwStatus

型: LPDWORD

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

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

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

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

型: HRESULT

この関数は、これらの値のいずれかを返すことができます。

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

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

SHIsFileAvailableOffline がOFFLINE_STATUS_LOCALとOFFLINE_STATUS_REMOTEの両方を返す場合、ファイルまたはディレクトリは両方の場所で開かれます。これは、サーバーがオンラインの場合に一般的です。

要件	値
サポートされている最小のクライアント	Windows 2000 Professional [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	shellapi.h
Library	Shell32.lib
[DLL]	Shell32.dll (バージョン 5.0 以降)