OLE Automation: Using Functions That Return Strings

 Last reviewed: February 6, 1998
Article ID: Q105683
The information in this article applies to:
  • Microsoft Word for Windows, versions 6.0, 6.0a, 6.0c
  • Microsoft Word for Windows 95, version 7.0

SUMMARY

When you use Microsoft WordBasic functions in Visual Basic, keywords that return strings--that is, keywords that end in a dollar sign ($)-- must be enclosed in square brackets or an error message will occur.

Example 1

The following WordBasic instruction returns the current date: 

   a$ = Date$()
In Visual Basic, the same instruction is specified as follows: 

   worddate = WordObj.[Date$]()
The following Visual Basic example uses Word's Date$() function to post the current date in a message box:

Dim WordObj As Object Dim worddate As String Set WordObj = CreateObject("Word.Basic") worddate = WordObj.[Date$]() MsgBox worddate

If you omit the square brackets that surround "Date$", Visual Basic will post the following error message: 

   Identifier can't end with type-declaration character

Example 2

The following WordBasic instruction shows the GetBookmark$() function as it might appear in a WordBasic macro: 

   mark$ = GetBookmark$("Address")
In Visual Basic, the same instruction would be specified as follows: 

   mark$ = WordObj.[GetBookmark$]("Address")
The following Visual Basic procedure opens the Word document TEST.DOC, and then uses the WordBasic GetBookmark$() function to return the text of the "Address" bookmark in a message box: 

Sub Command1_Click ()
Dim WordObj As Object Dim Mark As String Set WordObj = CreateObject("Word.Basic") WordObj.FileOpen "D:\WinWord6\Test.doc" Mark = WordObj.[GetBookmark$]("Address") MsgBox Mark 
End Sub

More Information

Visual Basic 4.x does not require the square backets "[ ]". They can however be used, as with VB3, without modification.

KBCategory: kbmacro
KBSubcategory:
Additional query words: 6.0 ole automation word basic word6 word7
6.0a 6.0c 7.0 word95 object visual basic dollar sign brackets function
return winword
Keywords : kbole kbmacro
Version : 6.0 6.0a 6.0c 7.0
Platform : WINDOWS

THE INFORMATION PROVIDED IN THE MICROSOFT KNOWLEDGE BASE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. MICROSOFT DISCLAIMS ALL WARRANTIES, EITHER EXPRESS OR IMPLIED, INCLUDING THE WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL MICROSOFT CORPORATION OR ITS SUPPLIERS BE LIABLE FOR ANY DAMAGES WHATSOEVER INCLUDING DIRECT, INDIRECT, INCIDENTAL, CONSEQUENTIAL, LOSS OF BUSINESS PROFITS OR SPECIAL DAMAGES, EVEN IF MICROSOFT CORPORATION OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. SOME STATES DO NOT ALLOW THE EXCLUSION OR LIMITATION OF LIABILITY FOR CONSEQUENTIAL OR INCIDENTAL DAMAGES SO THE FOREGOING LIMITATION MAY NOT APPLY.

Last reviewed: February 6, 1998
© 1998 Microsoft Corporation. All rights reserved. Terms of Use.