| |
| INT WINAPI FtpGetFilePermissions(
|
| |
HCLIENT hClient, |
|
| |
LPCTSTR lpszFileName, |
|
| |
LPDWORD lpdwPermissions |
|
| );
|
The FtpGetFilePermissions function returns information
about the access permissions for a specific file on the server.
Parameters
- hClient
- Handle to the client session.
- lpszFileName
- A pointer to a string which contains the name of the file that
the access permissions are to be returned for. The filename cannot
contain any wildcard characters.
- lpdwPermissions
- A pointer to an unsigned long integer which will contain the
access permissions for the file when the function returns. The file
permissions are represented as bit flags, and may be one or more of
the following values:
| Constant |
Description |
| FILE_OWNER_READ |
The owner has permission to open the file for reading. If the
current user is the owner of the file, this grants the user the
right to download the file to the local system. |
| FILE_OWNER_WRITE |
The owner has permission to open the file for writing. If the
current user is the owner of the file, this grants the user the
right to replace the file. If this permission is set for a
directory, this grants the user the right to create and delete
files. |
| FILE_OWNER_EXECUTE |
The owner has permission to execute the contents of the file.
The file is typically either a binary executable, script or batch
file. If this permission is set for a directory, this may also
grant the user the right to open that directory and search for
files in that directory. |
| FILE_GROUP_READ |
Users in the specified group have permission to open the file
for reading. If the current user is in the same group as the file
owner, this grants the user the right to download the file. |
| FILE_GROUP_WRITE |
Users in the specified group have permission to open the file
for writing. On some platforms, this may also imply permission to
delete the file. If the current user is in the same group as the
file owner, this grants the user the right to replace the file. If
this permission is set for a directory, this grants the user the
right to create and delete files. |
| FILE_GROUP_EXECUTE |
Users in the specified group have permission to execute the
contents of the file. If this permission is set for a directory,
this may also grant the user the right to open that directory and
search for files in that directory. |
| FILE_WORLD_READ |
All users have permission to open the file for reading. This
permission grants any user the right to download the file to the
local system. |
| FILE_WORLD_WRITE |
All users have permission to open the file for writing. This
permission grants any user the right to replace the file. If this
permission is set for a directory, this grants any user the right
to create and delete files. |
| FILE_WORLD_EXECUTE |
All users have permission to execute the contents of the file.
If this permission is set for a directory, this may also grant all
users the right to open that directory and search for files in that
directory. |
Return Value
If the function succeeds, the return value is a result code. If
the function fails, the return value is FTP_ERROR. To get extended
error information, call FtpGetLastError.
Remarks
This function uses the STAT command to retrieve information
about the specified file. On some systems, the STAT command will
not return information on files that contain spaces or tabs in the
filename. In this case, the function will fail and value pointed to
by the lpdwPermissions parameter will be zero.
Requirements
Client: Requires Windows 7, Windows Vista or Windows
XP.
Server: Requires Windows Server 2008 or Windows Server
2003.
Header: Include cstools7.h.
Library: Use csftpav7.lib.
Unicode: Implemented as Unicode and ANSI versions.
See Also
FtpGetFileStatus, FtpSetFilePermissions
|
|