WD: Using SetDocumentVar to Store Variables in Documents

ID: Q106388

The information in this article applies to:

Microsoft Word for Windows, versions 6.0, 6.0a, 6.0c
Microsoft Word for Windows 95, versions 7.0, 7.0a
Microsoft Word for the Macintosh versions 6.0, 6.0.1, 6.0.1a

SUMMARY

This article describes how to set and retrieve document variables using Microsoft Word.

MORE INFORMATION

Microsoft provides programming examples for illustration only, without warranty either expressed or implied, including, but not limited to, the implied warranties of merchantability and/or fitness for a particular purpose. This article assumes that you are familiar with the programming language being demonstrated and the tools used to create and debug procedures. Microsoft support professionals 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 needs. If you have limited programming experience, you may want to contact the Microsoft fee-based consulting line at (800) 936-5200. For more information about the support options available from Microsoft, please see the following page on the World Wide Web:

   http://www.microsoft.com/support/supportnet/refguide/

You can use the Microsoft WordBasic SetDocumentVar command to set a string variable into a Word document or template. Document variables are similar to key names in a private settings file and are retrieved using the GetDocumentVar$() function. You can only set and access document variables using the WordBasic instructions SetDocumentVar and GetDocumentVar$().

The following sample macro uses the SetDocumentVar statement to store the contents of the A$ string variable with the current document under the name "FullName." When the string value needs to be returned, the GetDocumentVar$ function is used with the document variable name "FullName."

NOTE: Document variables that are added to a template are stored in all new documents that are based on the template.

   Sub MAIN
      A$ = "Joe Smith"
      SetDocumentVar "FullName", A$   'Set contents of A$ in document
      Name$ = GetDocumentVar$("FullName")   'retrieves contents of variable
      Msgbox Name$
   End Sub

To ensure that the document variable has been set correctly, use the SetDocumentVar() function instead of the statement form. The SetDocumentVar() function returns -1 if the document variable was set successfully.

For example:

   Sub MAIN
      A$ = "Joe Smith"
      n = SetDocumentVar("FullName", A$)   'Set contents of A$ in document
      If n = -1 then
         Name$ = GetDocumentVar$("FullName")'retrieves contents of variable
         Msgbox Name$
      Else
         Msgbox "Document variable not set."
      End If
   End Sub

After a macro is finished running, the values of the macro variables are not saved. If you need to preserve a value between sessions of a macro, you can store values using any of the following methods:

Use SetPrivateProfileString to store values to a private settings file.
Use SetDocumentVar to store values in a document.
Use SetProfileString to store values in the Win.ini file.
Use the WordBasic File Input/Output statements to write to a text file (for example, Write or Print statements).
Use SetAutoText to store values in an AutoText entry.

REFERENCES

"Microsoft Word Developer's Kit," pages 183-196

Additional query words: setdocumentvar getdocument document get set variable value

Keywords          : wordnt kbmacroexample winword macword word6 winword2 word7 word95 macword6 
Version           : WINDOWS:2.x,6.0,6.0a,6.0c,7.0,7.0a; MACINTOSH:6.0,6.0.1,6.0.1a
Platform          : MACINTOSH WINDOWS
Issue type        : kbhowto

Last Reviewed: April 9, 1999