Hide Table of Contents
SetProgressRange Method (IEdmTaskInstance)

Sets the range of the progress bar for the execution of this task instance.

Syntax

Visual Basic (Declaration) 
Sub SetProgressRange( _
   ByVal lMax As System.Integer, _
   ByVal lPos As System.Integer, _
   ByVal bsDocStr As System.String _
) 
C# 
void SetProgressRange( 
   System.int lMax,
   System.int lPos,
   System.string bsDocStr
)
C++/CLI 
void SetProgressRange( 
&   System.int lMax,
&   System.int lPos,
&   System.String^ bsDocStr
) 

Parameters

lMax
Maximum position in the progress bar
lPos
0 <= Current position in the progress bar <= lMax
bsDocStr
Description of what the add-in is currently doing

Example

See the examples in IEdmTaskInstance.

Remarks

The task add-in calls this method at the start of processing of the hook, EdmCmdType.EdmCmd.TaskRun, to initialize the task list progress bar in the task list window of the EPDM Administration tool.

The task add-in calls IEdmTaskInstance::SetProgressPos periodically during processing of the hook, EdmCmdType.EdmCmd.TaskRun, to update the progress bar.

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:   SetProgressRange 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) 2014 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.