ITask Property Methods

These methods are not supported in Windows CE Platform Builder 3.0.

The property methods of the ITask interface read the properties described in the following table. For more information, see Interface Property Methods.

Properties in Vtable Order

Property Description
Subject
[Visual Basic]
Access: Read/Write
Data Type: String
[C++]
HRESULT get_Subject
([out] BSTR *pbstrSubject);
HRESULT put_Subject
([in] BSTR bstrSubject);
Returns or sets the subject for the task. This string is limited to 4095 characters.
Categories
[Visual Basic]
Access: Read/Write
Data Type: String
[C++]
HRESULT get_Categories
([out] BSTR *pbstrCategories);
HRESULT put_Categories
([in] BSTR bstrCategories);
Returns or sets the categories assigned to the task. Maximum length is 1023 characters.
StartDate
[Visual Basic]
Access: Read/Write
Data Type: Date
[C++]
HRESULT get_StartDate
([out] DATE *pdaStartDate);
HRESULT put_StartDate
([in] DATE daStartDate);
Returns or sets when the task starts. StartDate must be less than or equal to DateCompleted. Dates must be set between 1/1/1900 and 12/31/2999 inclusive. The default is None.
DueDate
[Visual Basic]
Access: Read/Write
Data Type: Date
[C++]
HRESULT get_DueDate
([out] DATE *pdaDueDate);
HRESULT put_DueDate
([in] DATE daDueDate);
Returns or sets when the task is due. Dates must be set between 1/1/1900 and 12/31/2999 inclusive. The default is None.
DateCompleted
[Visual Basic]
Access: Read
Data Type: Date
[C++]
HRESULT get_DateCompleted
([out] DATE *pdaDateCompleted);
Returns when the task is completed. It gets set to the current date on the device when you set the Complete property. Dates must be set between 1/1/1900 and 12/31/2999 inclusive.
Importance
[Visual Basic]
Access: Read/Write
Data Type: Long
[C++]
HRESULT get_Importance
([out] long *plImportance);
HRESULT put_Importance
([in] long lImportance);
Returns or sets the importance of the meeting. Allowed settings are olImportanceLow, olImportanceNormal, or olImportanceHigh. The default is olImportanceNormal.
Complete
[Visual Basic]
Access: Read/Write
Data Type: Boolean
[C++]
HRESULT get_Complete
([out] VARIANT_BOOL *pbComplete);
HRESULT put_Complete
([in] VARIANT_BOOL bComplete);
Returns or sets whether the appointment is completed — TRUE if complete, FALSE if not complete. The default is FALSE. Setting this to TRUE sets the DateCompleted property to the current date on the device.
IsRecurring
[Visual Basic]
Access: Read
Data Type: Boolean
[C++]
HRESULT get_IsRecurring
([out] VARIANT_BOOL *pbIsRecurring);
Returns whether the task is recurring. This is useful to use in a restriction string, to quickly discern whether or not a task is recurring.
Sensitivity
[Visual Basic]
Access: Read/Write
Data Type: Long
[C++]
HRESULT get_Sensitivity
([out] long *plSensitivity);
HRESULT put_Sensitivity
([in] long lSensitivity);
Returns or sets the sensitivity for a task as normal (olNormal) or private (olPrivate). The default setting for a new task is olNormal.
TeamTask
[Visual Basic]
Access: Read/Write
Data Type: Boolean
[C++]
HRESULT get_TeamTask
([out] VARIANT_BOOL *pbTeamTask);
HRESULT put_TeamTask
([in] VARIANT_BOOL bTeamTask);
Returns or sets whether the task is a team task. TRUE if it is a team task.
ReminderSet
[Visual Basic]
Access: Read/Write
Data Type: Boolean
[C++]
HRESULT get_ReminderSet
([out] VARIANT_BOOL *pbReminderSet);
HRESULT put_ReminderSet
([in] VARIANT_BOOL bReminderSet);
Returns or sets whether the user wants to be reminded of a Task. The default for this is the current setting for the Tasks application.
ReminderSoundFile
[Visual Basic]
Access: Read/Write
Data Type: String
[C++]
HRESULT get_ReminderSoundFile
([out] BSTR *pbstrReminderSoundFile);
HRESULT put_ReminderSoundFile
([in] BSTR bstrReminderSoundFile);
Returns or sets the path and file name of the sound file to play when the reminder occurs for the task. This property is valid only if the ReminderSet property is TRUE and the ReminderOptions property includes olSound. The default for this is the current setting for the Tasks application or Alarm1.wav if none.

Maximum length is 255 characters.

ReminderOptions
[Visual Basic]
Access: Read/Write
Data Type: Long
[C++]
HRESULT get_ReminderOptions
([out] long *plReminderOptions);
HRESULT put_ReminderOptions
([in] long lReminderOptions);
Returns or sets the type of a reminder. Sum of any of the following constants:

olLED activates the LED (light emitting diode) on a device.

olVibrate activates any vibration indicator on a device.

olDialog displays a dialog.

olSound plays the file specified by ReminderSoundFile.

olRepeat repeats the reminder.

Sum different options to simultaneously provide multiple types of reminders. Note that the setting this property clears any previous setting. The default for this is the current setting in the Tasks application.

Because Windows CE devices support several notification options not supported by desktop computers (such as flashing LED or vibration), this property replaces the Outlook ReminderPlaySound property.

ReminderTime
[Visual Basic]
Access: Read/Write
Data Type: Date
[C++]
HRESULT get_ReminderTime
([out] DATE *pdaReminderTime);
HRESULT put_ReminderTime
([in] DATE daReminderTime);
Returns or sets when a reminder occurs before the start or due date of a task. The date must be set before the midnight (or 8 AM) on the due date and no longer than 45 days before the start date.

The default for this is the user setting in the Task Options dialog box.

Body
[Visual Basic]
Access: Read/Write
Data Type: String
[C++]
HRESULT get_Body
([out] BSTR *pbstrBody);
HRESULT put_Body
([in] BSTR bstrBody);
Returns or sets the text of the notes accompanying an appointment. The maximum size is 60 KB.
BodyInk
[C++]
HRESULT get_BodyInk
([out] CEBLOB **ppBodyInk);
HRESULT put_BodyInk
([in] CEBLOB *pBodyInk);
Returns or sets a Binary Large Object (BLOB) describing the Ink Note information. The properties Body and InkBody both access the same property. The Body returns only the string value of the Body while the BodyInk property returns an Ink BLOB that can be set to an Ink Control.
Application
[Visual Basic]
Access: Read
Data Type: Application
[C++]
HRESULT get_Application
([out] IPOutlookApp **ppIPOutlookApp);
Returns the Application object.
Oid
[Visual Basic]
Access: Read
Data Type: Long
[C++]
HRESULT get_Oid
([out] long *plOid);
Returns the object identifier (OID) for an item. This may be necessary for replication services.

Return Values

Each property method supports the standard HRESULT return values, including S_OK.

Remarks

Pocket Outlook's does not support the desktop Outlook's ReminderOverrideDefault property. When you create task, Pocket Outlook automatically creates it with the default reminder information. When you set individual reminder properties, they automatically override the defaults.

See Also

ITask::Unknown

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.