Hide Table of Contents
IGetLeaderAtIndex2 Method (IGtol)

Gets information about the specified leader on this GTol.

.NET Syntax

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

Parameters

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

Return Value

  • in-process, unmanaged C++: Pointer to 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

    A GTol can have a straight leader (1 segment) or a bent leader (2 segments), or it might have a perpendicular leader, which can have either 2 or 3 segments, depending on the situation. The returned array contains the point information to define the leader. It contains the x,y,z coordinates for each vertex in the leader. It can contain up to 12 doubles (4 sets of x,y,z values).

    Because the return value is passed into this method, it should be dimensioned to 12 before this method is called to allow for the maximum number of items that can be returned (4 segments). Upon return from the API, the PointCount argument contains the actual number of points stored in the array. Multiply this number by 3 to determine the number of array items actually used.

     

    See Also

    Availability

    SOLIDWORKS 2004 SP2, Revision Number 12.2


    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:   IGetLeaderAtIndex2 Method (IGtol)
    *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) 2018 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.