Function AddLightSourceExtProperty( _
   ByVal ID As System.Integer, _
   ByVal PropertyExtension As System.Object _
) As System.Integer

Dim instance As IModelDoc2
Dim ID As System.Integer
Dim PropertyExtension As System.Object
Dim value As System.Integer
 
value = instance.AddLightSourceExtProperty(ID, PropertyExtension)

System.int AddLightSourceExtProperty( 
   System.int ID,
   System.object PropertyExtension
)

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

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.