AnsweredAssumed Answered

API documentation

Question asked by Tom Hickerson on Mar 22, 2019
Latest reply on Mar 23, 2019 by Artem Taturevych

Like • Show 0 Likes0
Comment • 6

I have been creating some macros and digging my way through the documentation. One thing I can't seem to find is explications for things like

Extension.CustomPropertyManager

I see examples with set2 vs set1 and I can't see to find what the difference is.

Another example is swpart.getpathname In VBA if you attempt to type this it's not an available option yet it works just fine.

I have found the solidworks API help website, but it's not really helping me.

2019 SOLIDWORKS API Help - Welcome

Is there another resource that might help me more?

Thanks!

No one else has this question

Outcomes

6 Replies

Jim Sculley Mar 22, 2019 4:56 PM
Mark Correct
Correct Answer
Tom Hickerson wrote:

I have been creating some macros and digging my way through the documentation. One thing I can't seem to find is explications for things like
Extension.CustomPropertyManager
I see examples with set2 vs set1 and I can't see to find what the difference is.

One is obsolete, the other is not:

Generally, obsolete functions still work, but there is no guarantee and it is usually a better idea to use the newer function.

Another example is swpart.getpathname In VBA if you attempt to type this it's not an available option yet it works just fine.
I have found the solidworks API help website, but it's not really helping me.

Generally, you only want to use functions that are explicitly listed in the 'Members' section for a given object type. The fact that some functions such as GetPathName work for PartDoc (and AssemblyDoc and DrawingDoc) should be considered an exception to the rule.
Like • Show 1 Like1
Actions
Cody Kirsch Mar 22, 2019 6:12 PM
Mark Correct
Correct Answer
Check out Keith Rice's free videos and examples at cadsharp.com. He explains how to find the info you need with the API help in the first couple of videos. If you create a free account you get access to more videos and the paid for subscription is well worth it if you really get into writing macros or want to make an Add-in.
Like • Show 2 Likes2
Actions
- Christian Chu @ Cody Kirsch on Mar 22, 2019 6:13 PM
  Mark Correct
  Correct Answer
  Cody Kirsch wrote:
  
  Check out Keith Rice's free videos and examples at cadsharp.com. He explains how to find the info you need with the API help in the first couple of videos.
  It's a good one. Also Artem Taturevych site includes lot of samples and tutorials
  Like • Show 2 Likes2
  Actions
  - Artem Taturevych @ Christian Chu on Mar 22, 2019 6:33 PM
    Mark Correct
    Correct Answer
    Christian, thanks a lot for mention!
    
    Tom, the IAssemblyDoc, IPartDoc, IDrawingDoc can be directly queried (cast) from IModelDoc2 which means that they will inherit of the APIs. Check this article: 2018 SOLIDWORKS API Help - Understanding the SOLIDWORKS API Class Hierarchy
    
    You can find more examples and articles here: API & Macros
    Like • Show 1 Like1
    Actions
    - Christian Chu @ Artem Taturevych on Mar 22, 2019 6:40 PM
      Mark Correct
      Correct Answer
      Artem Taturevych - Thanks to you for all excellent resources you posted online
      
      Like • Show 3 Likes3
      Actions
Artem Taturevych Mar 23, 2019 3:07 AM
Mark Correct
Correct Answer
I have just published a blog article with detailed explanation as well as interactive API object diagram: Fundamentals: API Object Model
Like • Show 0 Likes0
Actions

API documentation

Outcomes

Related Content

Recommended Content