Modifying Method Signatures in Dynamics AX

by | Updated August 15, 2016 | Development, Dynamics AX

I saw this in code recently and wanted to call it out so you don’t make this mistake.  If you are modifying an existing AX method, try to avoid modifying the method’s signature – i.e. try not to mess with the list of parameters required for that method.  If you modify the method signature in Dynamics AX, the customer will very likely have a merging problem with that method going forward.  If it is a Microsoft method and in the next version Microsoft adds another parameter to the method, the customer instantly has a problem.  Any new methods Microsoft added to call the method will no longer compile because we have overridden the method and changed what one of the parameters means.  In a lot of scenarios you can get around the need for a parameter by adding a new parm method to the object and setting it from your calling code, then you don’t have to alter the method parameters.

 

Having said all of that, if you have to modify a method’s signature:

  1. Add your new parameter to the end of the parameter list for the method
  2. Make it optional.

 

If you put the parameter at the beginning of the parameter list or somewhere in the middle, all of the methods calling into this one will no longer compile and you’ll have to go modify them as well.  In general, you want to keep our fingerprint of modifications as light as possible.

 

If you make the method optional all of the existing methods calling this method should still function because they’ll use the default value.

Related Posts

0 Comments

Submit a Comment

Your email address will not be published. Required fields are marked *

Upcoming Events

october

06oct10:00 am10:30 amPreview of D365 Business Central Fall Release Features and Functionality

06oct12:00 pm12:30 pmInsider's Guide to New Features Available in the Fall Release of D365 Finance and Supply Chain

07oct11:00 am12:00 pmConfab LIVE with Stoneridge - Dataverse and Dynamics in Review – Let’s Get Technical

13oct12:00 pm12:30 pmWave 2 Release – What’s Coming for Dynamics 365 Sales and Customer Service

21oct11:00 am12:00 pmConfab LIVE with Stoneridge - Dataverse and Dynamics in Review – Let’s Get Functional

26oct(oct 26)9:00 am28(oct 28)5:00 pmStoneridge Connect Leadership and Community Conference

november

04nov11:00 am12:00 pmConfab LIVE with Stoneridge - Challenging the Development Paradigm

About Stoneridge
Stoneridge Software is a unique Microsoft Gold Partner, with emphasis on partner. With specialties in Microsoft Dynamics 365, Microsoft Dynamics AX, Microsoft Dynamics NAV, Microsoft Dynamics GP and Microsoft Dynamics CRM, we focus on attracting the most knowledgeable experts in the field to our team, and prioritize delivering stellar solutions with maximum impact for your business. At Stoneridge, we are deeply committed to your results. Each engagement is met with a dedicated team, ready to provide thorough, tailored, and expert service. Based in Minnesota, we intentionally “step into your shoes,” wherever you are. We focus on what you care about, and develop trusting, long-term relationships with our clients.

Subscribe To Our Blog

Sign up to get periodic updates on the latest posts.

Thank you for subscribing!

X