11.7.10 AsFile Method

Reads the response body and writes it to a file.

Input Arguments

Name

Type

Mandatory

Description

Path

String

No

The path to the output file. If not specified, a temporary file will be created and its path returned.

AutoDelete

Boolean

No

A boolean value that indicates whether the file will be deleted automatically when the request object goes out of scope. The default value is False.

 

Output Arguments

Name

Type

Mandatory

Description

ContentInfo

XPRIM_HttpContentInfo

No

Describes the properties of the response content.

Status

XPRIM_HttpResponseReadContentStatus

No

Indicates whether the response body was read successfully.

 

Return Value

Type

Description

String

The full path to the file containing the response body.

If a path is specified as an input parameter, the same path will be returned. If no path is specified, a path to a temporary file will be returned.