How to Properly Return a Value from a VBA Function in AutoCAD

Learn how to set the return value of a function in VBA for AutoCAD. This guide provides a clear example and step-by-step explanation to eliminate syntax errors and ensure functionality.
---

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: Set the return of a function to another module variable

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
How to Properly Return a Value from a VBA Function in AutoCAD

When working with VBA (Visual Basic for Applications) in AutoCAD, you may come across various challenges, including errors related to function returns. One common issue many users face is attempting to set a function's return value to another module variable, which can lead to syntax errors if not done correctly. In this guide, we’ll address this problem in detail and provide a clear solution.

The Problem

Let's say you have the following function in Module1 that is supposed to create or fetch a selection set in AutoCAD:

[[See Video to Reveal this Text or Code Snippet]]

Now, here’s how you might attempt to call this function in Module2:

[[See Video to Reveal this Text or Code Snippet]]

However, both the above and below lines result in a "Syntax error" from AutoCAD's VBAIDE:

[[See Video to Reveal this Text or Code Snippet]]

The Solution

The issue arises because the function AddSelectionSet is not returning any value. To resolve the syntax error and ensure that the function can return the selection set, you need to explicitly set the function's return value at the end of its execution.

Step-by-step Breakdown

Modify Your Function: Update the AddSelectionSet function to include a return statement. Here’s how it should look:

[[See Video to Reveal this Text or Code Snippet]]

Call the Function Correctly: After modifying the function, you can call it in your Module2 without issues:

[[See Video to Reveal this Text or Code Snippet]]

What This Accomplishes

By adding Set AddSelectionSet = ss, you:

Ensure that the function returns the created or retrieved AcadSelectionSet.

Avoid syntax errors by correctly utilizing the Set keyword when assigning the return value of a function.

Conclusion

By following these steps, you can effectively set the return value of a function to another module variable in VBA for AutoCAD. This solution not only resolves the syntax error but also enhances your ability to manage selection sets within your AutoCAD projects.

Implementing these adjustments will allow you to successfully utilize your custom functions, making your VBA scripts more robust and functional. Happy coding!