Hide Table of Contents
SetLightSourceName Method (IModelDoc2)

Sets the light source name used internally by the SOLIDWORKS software.

.NET Syntax

Visual Basic (Declaration) 
Function SetLightSourceName( _
   ByVal ID As System.Integer, _
   ByVal NewName As System.String _
) As System.Boolean
Visual Basic (Usage) 
Dim instance As IModelDoc2
Dim ID As System.Integer
Dim NewName As System.String
Dim value As System.Boolean
 
value = instance.SetLightSourceName(ID, NewName)
C# 
System.bool SetLightSourceName( 
   System.int ID,
   System.string NewName
)
C++/CLI 
System.bool SetLightSourceName( 
&   System.int ID,
&   System.String^ NewName
) 

Parameters

ID

ID of the light source whose name you want to set

NewName

Name to be given to the specified light source

Return Value

True if the name is set successfully, false otherwise

Remarks

The light source ID ranges from 0 to n, where n = (the total number of light sources - 1). To get the total number of light sources, call IModelDoc2::GetLightSourceCount.

 

See Also

Availability

SOLIDWORKS 2001Plus FCS, Revision Number 10.0


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:   SetLightSourceName Method (IModelDoc2)
*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.