Hide Table of Contents
ShowHelp Method (ISldWorks)

Displays the specified Help topic.

.NET Syntax

Visual Basic (Declaration) 
Sub ShowHelp( _
   ByVal HelpFile As System.String, _
   ByVal HelpTopic As System.Integer _
) 
Visual Basic (Usage) 
Dim instance As ISldWorks
Dim HelpFile As System.String
Dim HelpTopic As System.Integer
 
instance.ShowHelp(HelpFile, HelpTopic)
C# 
void ShowHelp( 
   System.string HelpFile,
   System.int HelpTopic
)
C++/CLI 
void ShowHelp( 
&   System.String^ HelpFile,
&   System.int HelpTopic
) 

Parameters

HelpFile
Name of the Help file that contains the Help topic
HelpTopic

ID of Help topic to display

Example

STDMETHODIMP CFuncFeatApp::appCallbackFunction(int cmd,int data,LPDISPATCH dsp, BOOL *retval)

{

            switch (cmd)

            {

            case     swAppIsNewCmd:

                        *retval = VARIANT_True; //Set to True if data is new

                        break;

            case     swAppWhatsNewDescription:

                            m_iSldWorks->ShowHelp(_T("name_of_your_Help_system.chm"), cmd);

                        break;

            case     swAppHelpContext:

                        break;

            }

            return S_OK;

}

Example

Remarks

You can use this method with ISldWorks::AddCallback to implement Interactive What's New for your add-in.
 

See Also

Availability

SolidWorks 2006 FCS, Revision Number 14.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:   ShowHelp Method (ISldWorks)
*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.