Hide Table of Contents
GetLightSourceExtProperty Method (IModelDoc2)

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

.NET Syntax

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

Parameters

ID

ID of the light source

PropertyId

ID of the property extension (see Remarks)

Return Value

Value stored for the light source

Remarks

The type returned is based on the how the data was placed. See IModelDoc2::AddLightSourceExtProperty for details.

Values for Id can range from 0 to n, where n = (the total number of light sources - 1). To get the total number of light sources, use IModelDoc2::GetLightSourceCount.

The PropertyId parameter takes a 0-based index of the property. Values returned from IModelDoc2::AddLightSourceExtProperty must be decremented by 1 when used as input to IModelDoc2::GetLightSourceExtProperty. However, do not decrement the error value of -1.

 

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:   GetLightSourceExtProperty 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.