Visual FoxPro

Read the REST Response Body into a Stream

Demonstrates Rest.ReadRespBodyStream, which reads the response body into a Stream. The optional flag sets the stream character set from the response Content-Type charset for textual responses.

The file paths are relative to the application's current working directory. Absolute paths may also be used. Supply the paths appropriate to your own environment.

Background. The staged request model separates sending from reading: a SendReq method transmits the request, ReadResponseHeader reads the status line and headers, and a ReadResp method reads the body. This gives fine control over large or streamed messages compared with the single-call full-request methods.

Chilkat Visual FoxPro Downloads

Download Chilkat for Visual FoxPro

Visual FoxPro

LOCAL lnSuccess
LOCAL loRest
LOCAL lnBTls
LOCAL lnBAutoReconnect
LOCAL lnStatusCode
LOCAL loSbError
LOCAL loRespStream
LOCAL lnBAutoSetCharset

lnSuccess = 0

loRest = CreateObject('Chilkat.Rest')
lnBTls = 1
lnBAutoReconnect = 1
lnSuccess = loRest.Connect("example.com",443,lnBTls,lnBAutoReconnect)
IF (lnSuccess = 0) THEN
    ? loRest.LastErrorText
    RELEASE loRest
    CANCEL
ENDIF

*  The file paths are relative to the application's current working directory.  Absolute paths
*  may also be used.  Supply the paths appropriate to your own environment.

lnSuccess = loRest.SendReqNoBody("GET","/api/images/1")
IF (lnSuccess = 0) THEN
    ? loRest.LastErrorText
    RELEASE loRest
    CANCEL
ENDIF

lnStatusCode = loRest.ReadResponseHeader()
IF (lnStatusCode < 0) THEN
    ? loRest.LastErrorText
    RELEASE loRest
    CANCEL
ENDIF

*  Check for the expected success status code.  If the response is not 200, the body is likely
*  error text formatted as JSON, XML, or HTML rather than the expected binary content.  In that case
*  read the body as text, report it, and return.
IF (lnStatusCode <> 200) THEN
    loSbError = CreateObject('Chilkat.StringBuilder')
    lnSuccess = loRest.ReadRespSb(loSbError)
    IF (lnSuccess = 0) THEN
        ? loRest.LastErrorText
        RELEASE loRest
        RELEASE loSbError
        CANCEL
    ENDIF

    ? "Request failed with status code " + STR(lnStatusCode)
    ? loSbError.GetAsString()
    RELEASE loRest
    RELEASE loSbError
    CANCEL
ENDIF

*  The status code is 200.  Read the response body into a Stream.  Here the stream's sink is a local
*  file, which is appropriate for large or binary responses.
loRespStream = CreateObject('Chilkat.Stream')
loRespStream.SinkFile = "qa_output/image.png"

*  If the 2nd argument is 1 and the response is textual, the stream's character set is set from
*  the response Content-Type charset.  It has no effect for binary responses.
lnBAutoSetCharset = 1
lnSuccess = loRest.ReadRespBodyStream(loRespStream,lnBAutoSetCharset)
IF (lnSuccess = 0) THEN
    ? loRest.LastErrorText
    RELEASE loRest
    RELEASE loSbError
    RELEASE loRespStream
    CANCEL
ENDIF

? "Response body written to the stream sink."

RELEASE loRest
RELEASE loSbError
RELEASE loRespStream