Skip to content

Latest commit

 

History

History
146 lines (101 loc) · 4.88 KB

nf-cscobj-iofflinefilescache-ispathcacheable.md

File metadata and controls

146 lines (101 loc) · 4.88 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:cscobj.IOfflineFilesCache.IsPathCacheable
IOfflineFilesCache::IsPathCacheable (cscobj.h)
Determines whether a specified UNC path is in the Offline Files cache.
IOfflineFilesCache interface [Offline Files]
IsPathCacheable method
IOfflineFilesCache.IsPathCacheable
IOfflineFilesCache::IsPathCacheable
IsPathCacheable
IsPathCacheable method [Offline Files]
IsPathCacheable method [Offline Files]
IOfflineFilesCache interface
OFFLINEFILES_CACHING_MODE_AUTO_DOC
OFFLINEFILES_CACHING_MODE_AUTO_PROGANDDOC
OFFLINEFILES_CACHING_MODE_MANUAL
OFFLINEFILES_CACHING_MODE_NOCACHING
OFFLINEFILES_CACHING_MODE_NONE
cscobj/IOfflineFilesCache::IsPathCacheable
of.iofflinefilescache_ispathcacheable
of\iofflinefilescache_ispathcacheable.htm
of
4d9a2fda-baad-4ada-8a07-f39c9cfafdfa
12/05/2018
IOfflineFilesCache interface [Offline Files],IsPathCacheable method, IOfflineFilesCache.IsPathCacheable, IOfflineFilesCache::IsPathCacheable, IsPathCacheable, IsPathCacheable method [Offline Files], IsPathCacheable method [Offline Files],IOfflineFilesCache interface, OFFLINEFILES_CACHING_MODE_AUTO_DOC, OFFLINEFILES_CACHING_MODE_AUTO_PROGANDDOC, OFFLINEFILES_CACHING_MODE_MANUAL, OFFLINEFILES_CACHING_MODE_NOCACHING, OFFLINEFILES_CACHING_MODE_NONE, cscobj/IOfflineFilesCache::IsPathCacheable, of.iofflinefilescache_ispathcacheable
cscobj.h
Windows
Windows Vista
Windows Server 2008
CscSvc.dll; CscObj.dll
Windows
19H1
IOfflineFilesCache::IsPathCacheable
cscobj/IOfflineFilesCache::IsPathCacheable
c++
APIRef
kbSyntax
COM
CscSvc.dll
CscObj.dll
IOfflineFilesCache.IsPathCacheable

IOfflineFilesCache::IsPathCacheable

-description

Determines whether a specified UNC path is in the Offline Files cache.

-parameters

-param pszPath [in]

The UNC path of the item.

-param pbCacheable [out]

Receives TRUE if the item is in the Offline Files cache, FALSE if not.

-param pShareCachingMode [out]

Receives one of the following OFFLINEFILES_CACHING_MODE enumeration values indicating the caching configuration of the applicable network shared folder under which the specified item exists.

OFFLINEFILES_CACHING_MODE_NONE (0)

No caching mode value was found. This value is used when the item is not cacheable or an error has occurred.

OFFLINEFILES_CACHING_MODE_NOCACHING (1)

The shared folder is configured to disallow caching.

OFFLINEFILES_CACHING_MODE_MANUAL (2)

The shared folder is configured to allow manual caching.

OFFLINEFILES_CACHING_MODE_AUTO_DOC (3)

The shared folder is configured to allow automatic caching of documents.

OFFLINEFILES_CACHING_MODE_AUTO_PROGANDDOC (4)

The shared folder is configured to allow automatic caching of programs and documents.

-returns

Returns S_OK if successful, or an error value otherwise.

-remarks

The caching mode value returned is equivalent to the CSC_MASK value associated with SHARE_INFO_1005 returned by NetShareGetInfo. The value mapping is as follows:

OFFLINEFILES_CACHING_MODE Value SHARE_INFO_1005 Value
OFFLINEFILES_CACHING_MODE_NOCACHING 0
OFFLINEFILES_CACHING_MODE_MANUAL CSC_CACHE_MANUAL_REINT
OFFLINEFILES_CACHING_MODE_AUTO_DOC CSC_CACHE_AUTO_REINT
OFFLINEFILES_CACHING_MODE_AUTO_PROGANDDOC CSC_CACHE_VDO
 

These settings are configured as attributes of the shared folder on the server by clicking the Caching button on the shared folder's Sharing property page or by using the net share /cache command.

-see-also

IOfflineFilesCache

IOfflineFilesShareInfo::GetShareCachingMode

OFFLINEFILES_CACHING_MODE