Hide Table of Contents
IGetLeaderAtIndex Method (ISFSymbol)

Gets information about the specified leader on this surface finish symbol.

.NET Syntax

Visual Basic (Declaration) 
Function IGetLeaderAtIndex( _
   ByVal Index As System.Integer, _
   ByRef PointCount As System.Integer _
) As System.Double
Visual Basic (Usage) 
Dim instance As ISFSymbol
Dim Index As System.Integer
Dim PointCount As System.Integer
Dim value As System.Double
 
value = instance.IGetLeaderAtIndex(Index, PointCount)
C# 
System.double IGetLeaderAtIndex( 
   System.int Index,
   out System.int PointCount
)
C++/CLI 
System.double IGetLeaderAtIndex( 
&   System.int Index,
&   [Out] System.int PointCount
) 

Parameters

Index

Index of the line where the index begins at 0

PointCount

Number of (x,y,z) points returned in the array

Return Value

  • in-process, unmanaged C++: Pointer to an array of doubles (see Remarks)
  • VBA, VB.NET, C#, and C++/CLI: Not supported

    See In-process Methods for details about this type of method.

  • Remarks

    There can be 0, 1 or 2 lines used with the leader line. If the surface-finish sysmbol is not attached then, there are 0 lines; otherwise, you can have a straight leaderline (1 line) or a bent leaderline (2 lines). You must infer the number of leader lines based on ISFSymbol::IsAttached and ISFSymbol::HasExtraLeader.

    • ISFSymbol::IsAttached == false implies no leaderline and no leaderline points (PointCount=0).

    • ISFSymbol::HasExtraLeader == false means that this is a straight leaderline and 1 line (PointCount=2)

    • ISFSymbol::HasExtraLeader == True means that this is a bent leaderline and 2 lines (PointCount=3)

    Format of return information is the following array of doubles:

     

     

    retval[0] = x-coordinate of first leader point

     

    retval[1] = y-coordinate of first leader point

     

    retval[2] = z-coordinate of first leader point

     

     

     

    retval[3] = x-coordinate of second leader point

     

    retval[4] = y-coordinate of second leader point

     

    retval[5] = z-coordinate of second leader point

     

     

     

    retval[6] = x-coordinate of third leader point

     

    retval[7] = y-coordinate of third leader point

     

    retval[8] = z-coordinate of third leader point

     

    UseISFSymbol::GetLeaderCount to see how many leaders there are on the ISFSymbol object.

     

    See Also



    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:   IGetLeaderAtIndex Method (ISFSymbol)
    *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) 2013 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.