| INT PutFile( |
| |
LPCTSTR lpszLocalFile, |
|
| |
LPCTSTR lpszRemoteFile |
|
| ); |
The PutFile method transfers the specified file on the
local system to the server.
Parameters
- lpszLocalFile
- A pointer to a string that specifies the file
that will be transferred from the local system. The file pathing
and name conventions must be that of the local host.
- lpszRemoteFile
- A pointer to a string that specifies the file
on the server that will be created, overwritten or appended
to. The file naming conventions must be that of the host operating
system.
Return Value
If the method succeeds, the return value is the server result
code. If the method fails, the return value is HTTP_ERROR. To get
extended error information, call GetLastError.
Remarks
The PutFile method is used to transfer a file from the
local system to a server. Not all servers permit files to be
uploaded and some may require that specific configuration changes be
made to the server in order to support this functionality. Consult
your server's technical reference documentation to see if it supports
the PUT command, and if so, what must be done to enable it. It may be
required that the client authenticate itself using the
Authenticate method prior to uploading the file.
This method will cause the current thread to block until the file
transfer completes, a timeout occurs or the transfer is canceled.
During the transfer, the HTTP_EVENT_PROGRESS event will be
periodically fired, enabling the application to update any user
interface controls. Event notification must be enabled, either by
calling EnableEvents, or by registering a callback function
using the RegisterEvent method.
To determine the current status of a file transfer while it is in
progress, use the GetTransferStatus method.
Requirements
Minimum Desktop Platform: Windows 7 (Service Pack 1)
Minimum Server Platform: Windows Server 2008 R2 (Service Pack 1)
Header File: cstools10.h
Import Library: cshtpv10.lib
Unicode: Implemented as Unicode and ANSI versions.
See Also
EnableEvents,
GetData, GetFile,
GetTransferStatus,
PostData, PostFile,
PutData,
RegisterEvent
|