IContactProperties::GetDate Method

  • Article

Retrieves the date and time value at a specified property into a caller's FILETIME structure. All times are stored and returned as coordinated universal time (UTC).

Syntax

HRESULT GetDate(      
    LPCWSTR pszPropertyName,
    DWORD dwFlags,
    FILETIME *pftDateTime
);

Parameters

  • pszPropertyName
    [in] Specifies the property to retrieve.
  • dwFlags
    [in] Must be CGD_DEFAULT.
  • pftDateTime
    [in, out] Specifies caller-allocated FILETIME structure.

Return Value

Returns one of the following values:

S_OK pftDateTime contains a valid FILETIME.
S_FALSE The property has been present in the past but its value has been removed. The FILETIME has been zero'ed.
ERROR_PATH_NOT_FOUND No data found for this property name.

Remarks

To retrieve a single level property, set pszPropertyName to the property name.

To retrieve a value from a multi-value (hierarchical) property, include the desired index as part of pszPropertyName using the form: toplevel/secondlevel[1]/thirdlevel. NOTE: the first element of a set is index 1, so index [0] is invalid.