Microsoft KB Archive/141288

= XL: How to Use a Custom Function in Another Workbook =

Article ID: 141288

Article Last Modified on 10/11/2006

-

APPLIES TO


 * Microsoft Excel 97 Standard Edition
 * Microsoft Excel 95 Standard Edition
 * Microsoft Excel 5.0 Standard Edition
 * Microsoft Excel 5.0c
 * Microsoft Excel 98 for Macintosh
 * Microsoft Excel 5.0 for Macintosh
 * Microsoft Excel 5.0a for Macintosh

-



This article was previously published under Q141288





SUMMARY
In Microsoft Excel, you can create custom Microsoft Visual Basic for Applications functions to perform calculations. By default, these custom functions are available to all worksheets in the workbook that contains the custom function. Therefore, you can call them just as you call built-in functions in Microsoft Excel. However, if you attempt to call a custom function from outside of the workbook that contains the code, you must first make a reference to the workbook that contains the custom function.



MORE INFORMATION
Microsoft provides programming examples for illustration only, without warranty either expressed or implied. This includes, but is not limited to, the implied warranties of merchantability or fitness for a particular purpose. This article assumes that you are familiar with the programming language that is being demonstrated and with the tools that are used to create and to debug procedures. Microsoft support engineers can help explain the functionality of a particular procedure, but they will not modify these examples to provide added functionality or construct procedures to meet your specific requirements. The following steps show you how to create a simple custom function, how to call the function from the workbook that contains the code, and how to call this custom function from another workbook.

To Create a Custom Function
 Open a new workbook.  Insert a module sheet using the appropriate method for your version of Excel.

Excel 98 Macintosh Edition
 Start the Visual Basic Editor (press OPTION+F11). On the Insert menu, click Module.

Excel 97 for Windows
 Start the Visual Basic Editor (press ALT+F11).</li> On the Insert menu, click Module.</li></ol>

Excel versions 5.0, 7.0 for Windows, version 5.0 for Macintosh
 On the Insert menu, point to Macro, and then click Module.</li></ol> </li>  On the module sheet, type the following code: Function myfunction(x) myfunction = x * 2 End Function </li> Save this workbook as Test.xls.</li></ol>

To Call the Function from the Workbook That Contains the Function Code
To call this function from within Test.xls, type the following formula in cell A1 on Sheet1:

=myfunction(3)

Cell A1 should display the value 6, because the custom function doubled the value that was sent to it.

To Call the Function from Another Workbook
In order to call the function from a workbook, you must create a reference to the workbook that contains the code. To create a reference, follow these steps:  Open another new workbook.</li> Save this workbook as Test2.xls.</li>  Insert a module sheet using the appropriate method for your version of Excel.

Excel 98 Macintosh Edition
 Start the Visual Basic Editor (press OPTION+F11).</li> On the Insert menu, click Module.</li></ol>

Excel 97 for Windows
 Start the Visual Basic Editor (press ALT+F11).</li> On the Insert menu, click Module.</li></ol>

Excel Versions 5.0, 7.0 for Windows, Version 5.0 for Macintosh
 <li>On the Insert menu, point to Macro, and then click Module.</li></ol> </li> <li> Create a reference to Text.xls using the appropriate method for your version of Excel.

Excel 98 Macintosh Edition
<ol style="list-style-type: lower-alpha;"> <li>Press COMMAND+R to activate the Project Explorer window.</li> <li>Select VBAProject (Test.xls), and then click VBAProject Properties on the View menu.</li> <li>In the Project Name box, type MyProject, and then click OK.</li> <li>Select VBAProject (Test2.xls) in the Project Explorer window.</li> <li>On the Tools menu, click References. Click Myfunction, and then click OK.</li></ol>

Excel 97 for Windows
<ol style="list-style-type: lower-alpha;"> <li>Press CTRL+R to activate the Project Explorer window.</li> <li>Select VBAProject (Test.xls), and then click VBAProject Properties on the View menu.</li> <li>In the Project Name box, type MyProject, and then click OK.</li> <li>Select VBAProject (Test2.xls) in the Project Explorer window.</li> <li>On the Tools menu, click References. Click Myfunction, and then click OK.</li></ol>

Excel Versions 5.0, 7.0 for Windows, Version 5.0 for Macintosh
On the Tools menu, click References. Click Test.xls, and then click OK. </li></ol>

You should now have a reference to the workbook that contains the custom function. You can now call this custom function the same way you would call it if the workbook contained the code. For example, in cell A1, type the formula:

=myfunction(5)

Cell A1 should display the value 10.

NOTE: If the reference is not made as outlined in steps 1-4, cell A1 displays the #NAME? error value because Microsoft Excel does not know where to find the "myfunction" custom function. Naming the function and the project with the same name also results in the #NAME? error. Note also that you cannot create a reference to an unsaved workbook, so if you encounter an error when you try to create the reference, make sure the workbook that contains the custom function has been saved.

<div class="references_section">

Excel 97
For more information about custom functions, from the Visual Basic Editor, click Contents and Index on the Help menu, click the Index tab in Help, type the following text

function procedures

and then double-click the selected text to go to the "Writing a Function Procedure" topic. If you are unable to find the information you need, ask the Office Assistant.

Excel 98 Macintosh Edition
For more information about custom functions, from the Visual Basic Editor, click the Office Assistant, type function, click Search, and then click to view "Writing a Function Procedure."

Earlier Versions of Excel
For more information about custom functions, click Answer Wizard on the Help menu and type:

tell me how to create a user-defined function

Additional query words: 5.00a 5.00c

Keywords: kbdtacode kbhowto kbprogramming KB141288

-

[mailto:TECHNET@MICROSOFT.COM Send feedback to Microsoft]

© Microsoft Corporation. All rights reserved.