Skip to content

Latest commit

 

History

History
104 lines (73 loc) · 4.08 KB

nf-cscobj-iofflinefilesitemfilter-gettimefilter.md

File metadata and controls

104 lines (73 loc) · 4.08 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.IOfflineFilesItemFilter.GetTimeFilter
IOfflineFilesItemFilter::GetTimeFilter (cscobj.h)
Provides time-value-comparison semantics to control filtering of items based on time.
GetTimeFilter
GetTimeFilter method [Offline Files]
GetTimeFilter method [Offline Files]
IOfflineFilesItemFilter interface
IOfflineFilesItemFilter interface [Offline Files]
GetTimeFilter method
IOfflineFilesItemFilter.GetTimeFilter
IOfflineFilesItemFilter::GetTimeFilter
cscobj/IOfflineFilesItemFilter::GetTimeFilter
of.iofflinefilesitemfilter_gettimefilter
of\iofflinefilesitemfilter_gettimefilter.htm
of
397611e7-60e5-46d6-b90b-5aed7fff6a43
12/05/2018
GetTimeFilter, GetTimeFilter method [Offline Files], GetTimeFilter method [Offline Files],IOfflineFilesItemFilter interface, IOfflineFilesItemFilter interface [Offline Files],GetTimeFilter method, IOfflineFilesItemFilter.GetTimeFilter, IOfflineFilesItemFilter::GetTimeFilter, cscobj/IOfflineFilesItemFilter::GetTimeFilter, of.iofflinefilesitemfilter_gettimefilter
cscobj.h
Windows
Windows Vista
Windows Server 2008
CscSvc.dll; CscObj.dll
Windows
19H1
IOfflineFilesItemFilter::GetTimeFilter
cscobj/IOfflineFilesItemFilter::GetTimeFilter
c++
APIRef
kbSyntax
COM
CscSvc.dll
CscObj.dll
IOfflineFilesItemFilter.GetTimeFilter

IOfflineFilesItemFilter::GetTimeFilter

-description

Provides time-value-comparison semantics to control filtering of items based on time.

-parameters

-param pftTime [out]

Receives a pointer to a FILETIME structure containing the UTC time value that the item is to be compared with.

-param pbEvalTimeOfDay [out]

Receives a Boolean value indicating whether the time-of-day part of the FILETIME value is to be considered in the item evaluation. If the flag value is TRUE, the time-of-day is considered. If the flag value is FALSE, the time-of-day information is stripped from all time values involved in the evaluation; leaving only the year, month, and day.

This can be very helpful when the granularity of filtering is a day.

-param pTimeType [out]

Receives an OFFLINEFILES_ITEM_TIME enumeration value that indicates which time value associated with the cache item is to be used in the evaluation.

Only one value is to be provided. This is not a mask.

-param pCompare [out]

Receives an OFFLINEFILES_COMPARE enumeration value that indicates the type of logical comparison to perform between the selected item time and the filter time pointed to by the pftTime parameter.

-returns

Returns S_OK if the filter supports time filtering and the time filtering information is provided.

Returns E_NOTIMPL if time filtering is not supported.

Any other error value causes the creation of the enumerator to fail.

-remarks

In these expressions, the item time is placed on the left side of the expression. For example:

match = item_time >= filter_time

This method may be implemented in any filter type (inclusion, exclusion) or filter target (file, container).

-see-also

IOfflineFilesItemFilter

OFFLINEFILES_COMPARE

OFFLINEFILES_ITEM_TIME