Share via


ITask::get_IsRecurring

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

The IsRecurring property retrieves a value that indicates whether the Task is a Recurring Task. This is useful when constructing a restriction string.

Syntax

HRESULT get_IsRecurring(
   VARIANT_BOOL * pfIsRecurring
);

Parameters

  • pfIsRecurring
    [out] Reference to the Boolean flag. VARIANT_TRUE when the Task is a Recurring Task. For information about the VARIANT_BOOL type, see the union member of the PROPVARIANT structure.

Return Value

This method returns the standard values E_INVALIDARG, E_OUTOFMEMORY, E_UNEXPECTED, and E_FAIL, as well as the following:

  • S_OK
    The method completed successfully.

Remarks

The VARIANT_BOOL data type (also known as VT_BOOL) uses the value -1 to represent TRUE and 0 to represent FALSE. It is defined in the wtypes.h header file in the following manner:

typedef short VARIANT_BOOL;

A common programming error occurs when, for readability purposes, you want to set a VARIANT_BOOL value to TRUE or FALSE. You can achieve the same effect by using the aliases VARIANT_TRUE and VARIANT_FALSE, which are also defined in the wtypes.h header file.

#define VARIANT_TRUE  ((VARIANT_BOOL)0xffff)
#define VARIANT_FALSE ((VARIANT_BOOL)0)

Requirements

Header pimstore.h
Library Pimstore.lib
Windows Embedded CE Windows CE 2.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also

Reference

ITask
Pocket Outlook Object Model Interfaces
ITask::ClearRecurrencePattern
ITask::GetRecurrencePattern
ITask::SkipRecurrence

Other Resources

Pocket Outlook Object Model Enumerations