| |
| INT WINAPI FtpGetPriority(
|
| |
HCLIENT hClient |
|
| );
|
The FtpGetPriority function returns a value which
specifies the priority of file transfers.
Parameters
- hClient
- Handle to the client session.
Return Value
If the function succeeds, the return value is the current file
transfer priority. If the function fails, the return value is
FTP_ERROR. To get extended error information, call
FtpGetLastError.
Remarks
The FtpGetPriority function can be used to determine the
current priority assigned to file transfers performed by the
client. It may be one of the following values:
| Constant |
Description |
| FTP_PRIORITY_NORMAL |
The default priority which balances resource utilization and
transfer speed. It is recommended that most applications use this
priority. |
| FTP_PRIORITY_BACKGROUND |
This priority significantly reduces the memory, processor and
network resource utilization for the transfer. It is typically used
with worker threads running in the background when the amount of
time required perform the transfer is not critical. |
| FTP_PRIORITY_LOW |
This priority lowers the overall resource utilization for the
transfer and meters the bandwidth allocated for the transfer. This
priority will increase the average amount of time required to
complete a file transfer. |
| FTP_PRIORITY_HIGH |
This priority increases the overall resource utilization for
the transfer, allocating more memory for internal buffering. It can
be used when it is important to transfer the file quickly, and
there are no other threads currently performing file transfers at
the time. |
| FTP_PRIORITY_CRITICAL |
This priority can significantly increase processor, memory and
network utilization while attempting to transfer the file as
quickly as possible. If the file transfer is being performed in the
main UI thread, this priority can cause the application to appear
to become non-responsive. No events will be generated during the
transfer. |
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
FtpSetPriority
|
|