Hide Table of Contents
AddPrescribedDisplacement Method (ICWLoadsAndRestraintsManager)

Applies the specified prescribed displacement to the specified geometric entities to create a fixture.

.NET Syntax

Visual Basic (Declaration) 
Function AddPrescribedDisplacement( _
   ByVal Displacements As System.Object, _
   ByVal NLengthUnit As System.Integer, _
   ByVal DispArray As System.Object, _
   ByVal RefGeom As System.Object, _
   ByRef ErrorCode As System.Integer _
) As CWRestraint
Visual Basic (Usage) 
Dim instance As ICWLoadsAndRestraintsManager
Dim Displacements As System.Object
Dim NLengthUnit As System.Integer
Dim DispArray As System.Object
Dim RefGeom As System.Object
Dim ErrorCode As System.Integer
Dim value As CWRestraint
value = instance.AddPrescribedDisplacement(Displacements, NLengthUnit, DispArray, RefGeom, ErrorCode)
CWRestraint AddPrescribedDisplacement( 
   System.object Displacements,
   System.int NLengthUnit,
   System.object DispArray,
   System.object RefGeom,
   out System.int ErrorCode
CWRestraint^ AddPrescribedDisplacement( 
&   System.Object^ Displacements,
&   System.int NLengthUnit,
&   System.Object^ DispArray,
&   System.Object^ RefGeom,
&   [Out] System.int ErrorCode



Array: [disp_x_coord, disp_y_coord, disp_z_coord, x_bool, y_bool, z_bool]


Array Element Value Description
disp_x_coord Double Prescribed displacement in the x direction
disp_y_coord Double Prescribed displacement in the y direction
disp_z_coord Double Prescribed displacement in the z direction
x_bool 0 or 1 Whether to use disp_x_coord (1 to use, 0 to not)
y_bool 0 or 1 Whether to use disp_y_coord (1 to use, 0 to not)
z_bool 0 or 1 Whether to use disp_z_coord (1 to use, 0 to not)

(see Remarks)

Units of length as defined in swsLinearUnit_e
Array of entities to which to apply the prescribed displacement specified in Displacements
Reference entity for prescribed displacement direction
Error code as defined in swsRestraintError_e

Return Value




The Displacements parameter specifies:

  • length for reference geometry or flat faces

   - or -

  • angle of rotation for cylindrical or spherical faces

See Also


SOLIDWORKS Simulation API 2015 SP3

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

Subject:   Feedback on Help Topics
Page:   AddPrescribedDisplacement Method (ICWLoadsAndRestraintsManager)
*   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:


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

Web Help Content Version: API Help (English only) 2017 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.