Hide Table of Contents
GetLegendContourColors Method (ICWResults)

Gets the contour colors based on user-input colors.

.NET Syntax

Visual Basic (Declaration) 
Function GetLegendContourColors( _
   ByVal SPlotName As System.String, _
   ByRef VarColor As System.Object _
) As System.Integer
Visual Basic (Usage) 
Dim instance As ICWResults
Dim SPlotName As System.String
Dim VarColor As System.Object
Dim value As System.Integer
 
value = instance.GetLegendContourColors(SPlotName, VarColor)
C# 
System.int GetLegendContourColors( 
   System.string SPlotName,
   out System.object VarColor
)
C++/CLI 
System.int GetLegendContourColors( 
&   System.String^ SPlotName,
&   [Out] System.Object^ VarColor
)

Parameters

SPlotName
Plot name (see Remarks)
VarColor
Array of colors (see Remarks)

Return Value

Result code as defined in swsResultPlotColorOption_ErrorCode_e

Example

Remarks

Call ICWResults::GetPlotNames to populate SPlotName.

VarColor contains an array of RGB triplets. Each triplet represents a computed legend color:

[

   R[0,255] G[0,255] B[0,255]

   ...

]

If there are 14 colors in the legend, then the size of VarColor array is (14 * 3) = 42.

 

See Also

Availability

SOLIDWORKS Simulation API 2016 SP0


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:   GetLegendContourColors Method (ICWResults)
*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) 2016 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.

0.20.21