This function serves as an API that enables initiation of an HTTP DELETE request method for RESTful Web services, and then
waits for a response. The HTTP DELETE method is used to request a deletion of the specified resource. This function is different
from HttpDelete because a request pointer and length are passed in the request. In HttpDelete, destination-url fully identifies
the target to be deleted. Use HttpDeleteWithPayload when the URL cannot fully identify the resource, and additional information
must be passed in the request payload.
Usage
call "HttpDeleteWithPayload" using
destination-url
content-type
request-pointer
request-length
response-pointer
response-length
[extra-headers]
giving
response-status.
Parameters
- destination-url
- An alphanumeric item specifying the target URL for the DELETE.
- content-type
- An alphanumeric item specifying the value of the ContentType HTTP header variable.
- request-pointer
- A pointer to an alphanumeric item specifying the value of the ContentType HTTP header variable.
- request-length
- A numeric item specifying the length of the content to which
request-pointer points.
- response-pointer
- A pointer to an alphanumeric item specifying the value of the HTTP response. After use, use
NetFree to return memory used to store response.
- response-length
- A numeric item returning the length of the HTTP response to which
reponse-pointer points.
- extra-headers
- An optional alphanumeric item specifying extra headers to be added to the HTTP header. This argument consists of name/value
pairs separated by hex x"00", and ended with two x"00"s.
- response-status
- A status code. If a non-zero is returned, the request encountered an error. Use
NetGetError to get the string representation of the error.