Partager via


Fonction SHIsFileAvailableOffline (shellapi.h)

Détermine si un fichier ou un dossier est disponible pour une utilisation hors connexion. Cette fonction détermine également si le fichier doit être ouvert à partir du réseau, à partir du cache fichiers hors connexion local ou des deux emplacements.

Syntaxe

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

Paramètres

[in] pwszPath

Type : PCWSTR

Pointeur vers une valeur de chaîne qui spécifie le chemin d’accès complet à un fichier ou répertoire réseau. Ce chemin n’a pas besoin d’être au format UNC. Si pszPath n’est pas un chemin réseau, la fonction retourne E_INVALIDARG.

[out, optional] pdwStatus

Type : LPDWORD

Pointeur vers une variable de type DWORD qui reçoit un ou plusieurs des indicateurs suivants si la fonction réussit.

OFFLINE_STATUS_LOCAL (0x01)

Si le fichier est ouvert, il est ouvert dans le cache.

OFFLINE_STATUS_REMOTE (0x02)

Si le fichier est ouvert, il est ouvert sur le serveur.

OFFLINE_STATUS_INCOMPLETE (0x04)

La copie locale est actuellement incomplète. Le fichier ne peut pas être ouvert en mode hors connexion tant qu’il n’a pas été synchronisé.

Valeur retournée

Type : HRESULT

Cette fonction peut retourner l’une de ces valeurs.

Code de retour Description
S_OK
Le fichier ou le répertoire est mis en cache. Il est disponible hors connexion, sauf si OFFLINE_STATUS_INCOMPLETE est défini.
E_INVALIDARG
Le chemin d’accès n’est pas valide ou n’est pas un chemin d’accès réseau. Le fichier ou le répertoire n’est pas mis en cache.
E_FAIL
Le fichier ou le répertoire n’est pas mis en cache.

Remarques

Si pszPath est un répertoire, SHIsFileAvailableOffline ne retourne pas l’indicateur OFFLINE_STATUS_INCOMPLETE .

Si SHIsFileAvailableOffline retourne à la fois OFFLINE_STATUS_LOCAL et OFFLINE_STATUS_REMOTE, le fichier ou le répertoire est ouvert aux deux emplacements. Cela est courant lorsque le serveur est en ligne.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge Windows 2000 Server [applications de bureau uniquement]
Plateforme cible Windows
En-tête shellapi.h
Bibliothèque Shell32.lib
DLL Shell32.dll (version 5.0 ou ultérieure)