Hide Table of Contents
AddLightSourceExtProperty Method (IModelDoc2)

Stores a float, string, or integer value for the light source.

.NET Syntax

Visual Basic (Declaration) 
Function AddLightSourceExtProperty( _
   ByVal ID As System.Integer, _
   ByVal PropertyExtension As System.Object _
) As System.Integer
Visual Basic (Usage) 
Dim instance As IModelDoc2
Dim ID As System.Integer
Dim PropertyExtension As System.Object
Dim value As System.Integer
 
value = instance.AddLightSourceExtProperty(ID, PropertyExtension)
C# 
System.int AddLightSourceExtProperty( 
   System.int ID,
   System.object PropertyExtension
)
C++/CLI 
System.int AddLightSourceExtProperty( 
&   System.int ID,
&   System.Object^ PropertyExtension
) 

Parameters

ID
ID of the light source
PropertyExtension
Value you want to store for the light source

Return Value

ID of the extension property (see Remarks)

Remarks

This property extension is stored on the model document and is unique to the specified light source.

To add the property extension, you must first define the VARIANT type (float, string, or integer), give your variable a value, and then call this method to place the value on the light source for future reference.

This method returns a 1-based index of the added property. Values returned from IModelDoc2::AddLightSourceExtProperty must be decremented by 1 when used as input to IModelDoc2::GetLightSourceExtProperty. However, the error value of -1 should not be decremented.

 

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:   AddLightSourceExtProperty 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) 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.