Skip to content

HttpPostToFile - cHttpClient

Include: Use System\Http.pkg

Sends a POST request with a required body and writes the response body to a file.

Type: Function

Return data type: HttpStatus, which is an alias for UShort

Parameters

Parameter Type Description
sPath String Relative path or absolute URL.
sFile String File path to create or truncate for the response body.
vBody Variant Request body. Strings are sent as text/plain, UChar[] values are sent as application/octet-stream, and structs/arrays/other Variant values are serialized to JSON as application/json unless sContentType or Content-Type overrides it.
sContentType String Optional content type. When omitted, cHttpClient selects a content type from the body value or uses the existing Content-Type request header.

Syntax

Function HttpPostToFile String sPath String sFile Variant vBody {String sContentType} Returns HttpStatus

Call

Get HttpPostToFile of hoObj "/post" "response.body" vBody to eStatus

Description

Sends POST with a required body and optional content type, then writes response bytes directly to sFile. See Automatic request body serialization.