HttpDeleteFile
INT HttpDeleteFile(
HCLIENT hClient,  
LPCTSTR lpszFileName  
);

The HttpDeleteFile function deletes the specified file from the remote host.

Parameters

hClient
Handle to the client session.
lpszFileName
Points to a null-terminated string that specifies the name of the remote file to delete. The file pathing and name conventions must be that of the remote host.

Return Value

If the function succeeds, the return value is the server result code. If the function fails, the return value is HTTP_ERROR. To get extended error information, call HttpGetLastError.

Remarks

This function uses the DELETE command to delete the specified file from the server. The server must be configured to support this command, and client must have the appropriate permission to delete the file, or an error will be returned.

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

HttpGetFile, HttpPutFile


Copyright © 2008 Catalyst Development Corporation. All rights reserved.