company logo

HTTP :: DELETE - HTTP DELETE request

The function supports sending HTTP DELETE request to the WEB server passed in sURL.Response data returned from the server is stored in a result area and may be obtained by calling result(). The result area will be cleared when submitting the next HTTP request.

Return value:  Success ( bool  )

The value is true when the function was executed successfully. Otherwise the value is set to false.

Implementation overview

Implementation details

  1. Submitting request with default header
    bool HTTP  :: DELETE ( odaba::String &sURL )

    The function submits the request creating a default header, which may be displayed when creating the HTTP instance with bVerbose option set to true.

    • sURL - URI string

      The URL string is a Uniform Resource Identifier (URI) with the following syntax:

          [scheme:][//host[:port]/]path[?query][#fragment]

      At least, a path is required for a valid URI.

  2. to list
  3. Submitting request with specific header data
    bool HTTP  :: DELETE ( odaba::String &sURL, odaba::String &sHeader )

    In order to provide specific header data when submitting the request, Header data may be passed in sHeader.

    • sURL - URI string

      The URL string is a Uniform Resource Identifier (URI) with the following syntax:

          [scheme:][//host[:port]/]path[?query][#fragment]

      At least, a path is required for a valid URI.

    • sHeader - HTML message header

      Header options passed in the string have to be separated by new lines (\n). Header options have to be passed with option keyword and value separated by colon (:).

      Content-Type: text/xml

  4. to list
  5. Submitting request with authentication
    bool HTTP  :: DELETE ( odaba::String &sURL, odaba::String &sUser, odaba::String &sPassword )

    In order to provide authentication data according to basic RFC 2617 authentication, user name (sUser) and password (sPassword) have to be provided. The function creates authentication header data and submits the request.

    • sURL - URI string

      The URL string is a Uniform Resource Identifier (URI) with the following syntax:

          [scheme:][//host[:port]/]path[?query][#fragment]

      At least, a path is required for a valid URI.

    • sUser - User name
    • sPassword - User's password
  6. to list