Hide Table of Contents
IGetLeaderInfo Method (IGtol)

Gets information describing the layout of the GTol leader lines.

.NET Syntax

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

Parameters

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 with the leader line. If the GTol is not attached, then there are 0 lines. Otherwise, the GTol can have a straight leaderline (1 line) or a bent leaderline (2 lines). The caller must infer the number of leader lines based on IGtol::IsAttached and IGtol::HasExtraLeader.

    • IGtol::IsAttached() == false implies no leaderline; therefore, there are no leaderline points (PointCount=0).

    • IGtol::HasExtraLeader() == false means that this is a straight leaderline; therefore, there is 1 line (PointCount=2).

    • IGtol::HasExtraLeader() == True means that this is a bent leaderline; therefore, there are 2 lines (PointCount=3).

    The 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

    Use IGtol::GetLeaderCount to see how many leaders are on the IGTol 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:   IGetLeaderInfo 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) 2012 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.