.. highlightlang:: us

.. index:: GetFileWriteAccess

.. _getfilewriteaccess:

GetFileWriteAccess
==================

.. us.tag  GetFileWriteAccess ENGLISH FILE_MISC New530

:ref:`GetFileWriteAccess` checks if the user has write access for the given file.

.. function::  nAttrib = GetFileWriteAccess(ssFileName)

.. us.return

**Return Value**

*nAttib* is one of the following values:

.. list-table::
   :header-rows: 1

   * - Value
     - Meaning
   * - -1
     - File does not exist or cannot be accessed.
   * - 0
     - The user has only read access.
   * - 1
     - The user has write access.

.. us.params

**Parameters**

.. uparam:: ssFileName

   *ssFileName* specifies a complete file name.

.. us.example

**Example**

::

       nAttrib = GetFileWriteAccess(ssFileName);
       if (nAttrib == -1) {
           MessageBoxError(_s("The file \"%s\" does not exist."), ssFileName);
           return FALSE;
       } else if (nAttrib == 0) {
           MessageBoxError(_s("The file \"%s\" is write protected."), ssFileName);
           return FALSE;
       }

.. us.history

**History**

.. list-table::
   :header-rows: 1

   * - Version
     - Description
   * - 5.3.0
     - New.

.. seealso::
   :ref:`overview-files`,
   :ref:`FindFiles`,
   :ref:`SetFileAttributes`

:sub:`id-526499`