WD: WordBasic SetAttr Statement Adds Files Attributes

 Last reviewed: February 2, 1998
Article ID: Q105682
The information in this article applies to:
  • Microsoft Word for Windows, version 6.0, 6.0a, 6.0c
  • Microsoft Word for Windows NT, version 6.0
  • Microsoft Word for Windows 95, versions 7.0, 7.0a
  • Microsoft Word for the Macintosh, version 6.0

SUMMARY

The Microsoft WordBasic SetAttr statement sets file attributes for a specified file. Attributes that are set with the SetAttr statement are additive and do not remove previous attributes for the file.

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 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 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/supportnet/refguide/
The arguments for the SetAttr statement correspond to the file attributes you can set using the Properties command (File menu) in File Manager.

Syntax: 

   SetAttr Filename$, Attribute
Attributes: 

   0(zero)  Clears all attributes
   1        Read only
   2        Hidden
   4        System
   32       Archive
Example:

The following sample macro clears the current file attributes for Mydoc.doc and then adds the read-only file attribute.

Word for Windows

   Sub MAIN
      SetAttr "D:\WINWORD6\MYDOC.DOC", 0  'Clear all file attributes.
      SetAttr "D:\WINWORD6\MYDOC.DOC", 1  'Adds the read-only attribute.
   End Sub

Word for the Macintosh

   Sub MAIN
      SetAttr "Macintosh HD:MACWORD6:MYDOC.DOC", 0  ' Clear file attributes
      SetAttr "Macintosh HD:MACWORD6:MYDOC.DOC", 1  ' Adds the read-only
                                                    ' attribute.
   End Sub
If a file has the hidden and system attributes (value of 6, sum of 2 and 4) and you don't first clear the file attributes, the following statement sets the attributes to hidden, system, and read-only (value 7, sum of 2, 4, and 1). 

   SetAttr "D:\WINWORD6\MYDOC.DOC", 1  'adds the read-only attribute
NOTE: This does not apply to Word for the Macintosh. New file attributes set for a Word for the Macintosh file do not have to be cleared before new attributes are applied. The new attributes override those previously set.

Use the GetAttr() function to determine the current file attributes for a file. 

   n = GetAttr "D:\WINWORD6\MYDOC.DOC"
The file attribute value is stored in the variable "n".

NOTE: In the above example, the MsgBox command statement is optional. It allows for the display of the value returned.

REFERENCES

Programming with Microsoft Word Online Help, SetAttr topic

Additional query words: getattr
Keywords : kbmacroexample macword ntword word6 word7 word95 wordnt kbcode kbmacro kbprg
Version : WINDOWS: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 kbinfo

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 2, 1998
© 1998 Microsoft Corporation. All rights reserved. Terms of Use.