Skip to content

Latest commit

 

History

History
136 lines (86 loc) · 5.42 KB

nf-cscobj-iofflinefilescache-finditemex.md

File metadata and controls

136 lines (86 loc) · 5.42 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.FindItemEx
IOfflineFilesCache::FindItemEx (cscobj.h)
Locates a particular file or directory item in the cache. (IOfflineFilesCache.FindItemEx)
FindItemEx
FindItemEx method [Offline Files]
FindItemEx method [Offline Files]
IOfflineFilesCache interface
IOfflineFilesCache interface [Offline Files]
FindItemEx method
IOfflineFilesCache.FindItemEx
IOfflineFilesCache::FindItemEx
OFFLINEFILES_ITEM_QUERY_ADMIN
OFFLINEFILES_ITEM_QUERY_CONNECTIONSTATE
OFFLINEFILES_ITEM_QUERY_INCLUDETRANSPARENTCACHE
OFFLINEFILES_ITEM_QUERY_LOCALDIRTYBYTECOUNT
OFFLINEFILES_ITEM_QUERY_REMOTEDIRTYBYTECOUNT
OFFLINEFILES_ITEM_QUERY_REMOTEINFO
cscobj/IOfflineFilesCache::FindItemEx
of.iofflinefilescache_finditemex
of\iofflinefilescache_finditemex.htm
of
f7a247c0-1bb2-40d5-8914-758c8f6c4c51
12/05/2018
FindItemEx, FindItemEx method [Offline Files], FindItemEx method [Offline Files],IOfflineFilesCache interface, IOfflineFilesCache interface [Offline Files],FindItemEx method, IOfflineFilesCache.FindItemEx, IOfflineFilesCache::FindItemEx, OFFLINEFILES_ITEM_QUERY_ADMIN, OFFLINEFILES_ITEM_QUERY_CONNECTIONSTATE, OFFLINEFILES_ITEM_QUERY_INCLUDETRANSPARENTCACHE, OFFLINEFILES_ITEM_QUERY_LOCALDIRTYBYTECOUNT, OFFLINEFILES_ITEM_QUERY_REMOTEDIRTYBYTECOUNT, OFFLINEFILES_ITEM_QUERY_REMOTEINFO, cscobj/IOfflineFilesCache::FindItemEx, of.iofflinefilescache_finditemex
cscobj.h
Windows
Windows Vista
Windows Server 2008
CscSvc.dll; CscObj.dll
Windows
19H1
IOfflineFilesCache::FindItemEx
cscobj/IOfflineFilesCache::FindItemEx
c++
APIRef
kbSyntax
COM
CscSvc.dll
CscObj.dll
IOfflineFilesCache.FindItemEx

IOfflineFilesCache::FindItemEx

-description

Locates a particular file or directory item in the cache.

-parameters

-param pszPath [in]

UNC path of the file or directory to be located.

-param pIncludeFileFilter [in]

If provided, references the filter applied to the decision to include files. This parameter is optional and can be NULL.

-param pIncludeDirFilter [in]

If provided, references the filter applied to the decision to include directories. This parameter is optional and can be NULL.

-param pExcludeFileFilter [in]

If provided, references the filter applied to the decision to exclude files. This parameter is optional and can be NULL.

-param pExcludeDirFilter [in]

If provided, references the "filter" applied to the decision to exclude directories. This parameter is optional and may be NULL.

-param dwQueryFlags [in]

Flags affecting the amount of query activity at the time the item is located in the cache. The parameter can contain one or more of the following bit flags.

OFFLINEFILES_ITEM_QUERY_REMOTEINFO (0x00000001)

This flag is reserved for future use.

OFFLINEFILES_ITEM_QUERY_CONNECTIONSTATE (0x00000002)

If this flag is set, the find operation includes an extra call to the Offline Files store to obtain information about the connection state (online or offline) of the item. If this flag is not set, the operation does not include this extra operation, and connection state will be queried on demand when it is requested.

Note  If you know that you will need connection state for the item, setting this flag is slightly more efficient. If connection state is not required, it is more efficient to not set this flag.
 

OFFLINEFILES_ITEM_QUERY_LOCALDIRTYBYTECOUNT (0x00000004)

If this flag is set, the find operation includes an extra call to the Offline Files store to obtain information about the amount, in bytes, of unsynchronized ("dirty") data for the associated file in the local Offline Files cache.

OFFLINEFILES_ITEM_QUERY_REMOTEDIRTYBYTECOUNT (0x00000008)

This flag is reserved for future use.

OFFLINEFILES_ITEM_QUERY_INCLUDETRANSPARENTCACHE (0x00000010)

If this flag is set, the find operation includes transparently cached items.

OFFLINEFILES_ITEM_QUERY_ADMIN (0x80000000)

Allows administrators to find items cached by any user. If this flag is set and the caller is not an administrator, the method call fails.

-param ppItem [out]

Pointer to the IOfflineFilesItem interface of the cache item.

-returns

Returns S_OK if successful, or an error value otherwise.

Returns HRESULT_FROM_WIN32(ERROR_FILE_NOT_FOUND) if the cache entry is not found.

-remarks

FindItemEx is an enhanced version of FindItem that provides filtering capabilities similar to what is offered by cache item enumeration. Calling FindItem is equivalent to calling FindItemEx with all four filter parameters set to NULL.

-see-also

IOfflineFilesCache