| Visual Basic | |
|---|---|
Sub SetStatus( _ ByVal eStatus As EdmTaskStatus, _ Optional ByVal lHRESULT As System.Integer, _ Optional ByVal bsCustomMsg As System.String, _ Optional ByVal oNotificationAttachments As System.Object, _ Optional ByVal bsExtraNotificationMsg As System.String _ ) | |
| C# | |
|---|---|
void SetStatus( EdmTaskStatus eStatus, System.int lHRESULT, System.string bsCustomMsg, System.object oNotificationAttachments, System.string bsExtraNotificationMsg ) | |
| C++/CLI | |
|---|---|
void SetStatus( & EdmTaskStatus eStatus, & System.int lHRESULT, & System.String^ bsCustomMsg, & System.Object^ oNotificationAttachments, & System.String^ bsExtraNotificationMsg ) | |
Parameters
- eStatus
- Status of this task as defined in EdmTaskStatus
- lHRESULT
- Optional error code to display in the properties window when terminating the task; valid only if eStatus is EdmTaskStatus.EdmTaskStat_DoneFailed
- bsCustomMsg
- Optional error message to display when terminating the task; valid only if eStatus is EdmTaskStatus.EdmTaskStat_DoneFailed
- oNotificationAttachments
- Optional array of EdmSelItem2 structures; one structure for each file link to add to the notification message that is sent when the task completes
- bsExtraNotificationMsg
- Optional message to append to the notification message that is sent when the task completes
See the examples in IEdmTaskInstance.
The task add-in calls this method to inform the framework about the current status of the task.
- S_OK: The method successfully executed.
SOLIDWORKS PDM Professional 2010