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.

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