Hide Table of Contents
SetStatus Method (IEdmTaskInstance)

Sets the specified status of this task instance.

Syntax

Visual Basic (Declaration) 
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

Example

See the examples in IEdmTaskInstance.

Remarks

The task add-in calls this method to inform the framework about the current status of the task.

Return codes:

  • S_OK: The method successfully executed.
 

See Also

Availability

SOLIDWORKS Enterprise PDM 2010


Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   SetStatus Method (IEdmTaskInstance)
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:



x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2015 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.