|
|
| INT
HttpGetPriority(
|
|
|
HCLIENT hClient |
|
|
| );
|
The HttpGetPriority 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
HTTP_ERROR. To get extended error information, call
HttpGetLastError.
Remarks
The HttpGetPriority 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 |
|
HTTP_PRIORITY_NORMAL |
The default priority which balances resource
utilization and transfer speed. It is recommended that most
applications use this priority. |
|
HTTP_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. |
|
HTTP_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. |
|
HTTP_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. |
|
HTTP_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 Vista, Windows XP or Windows
2000 Professional.
Server: Requires Windows Server 2008, Windows Server 2003 or
Windows 2000 Server.
Header: Include cstools6.h.
Library: Use cshtpav6.lib.
Unicode: Implemented as Unicode and ANSI versions.
See Also
HttpSetPriority
|
|