Syntax

    #include <httpexp.h>
    #include <httpclnt.h> 
     
    int HttpGetReply (
       HINTERNET   hndl,
       int        *pHttpStatusCode,
       void       *pContext,
       void      (*pCallBackRoutine)(
                   void       *pContext,
                   HINTERNET   hndl,
                   int         returnCode,
                   int         httpStatusCode,
                   void       *reserved)
       );
    

Parameters

hndl

(IN) Specifies the connection handle returned from HttpConnect.

pHttpStatusCode

(OUT) Points to HTTP reply status, parsed from the first line of the HTTP reply header. Only valid if no error occurs. For a list of possible values, see Section 6.1, HTTP Status Codes.

pContext

(IN) Points to optional context data, which is passed to your callback function. For a synchronous request, set it to NULL.

pCallBackRoutine

(IN) Points to the callback function that is called when an asynchronous request returns. For a synchronous request, set it to NULL.

The callback function is passed the following parameters:

• pContext—Points to any optional context data that you passed in when you called HttpGetReply.
• hndl—Specifies the HTTP connection handle received for this request.
• returnCode—Specifies the error status for the HttpGetReply request. Zero indicates no errors; nonzero indicates an error. See Return Values for possible errors.
• httpStatusCode—Specifies the HTTP reply status, parsed from the first line of the HTTP reply headers. Valid only if the returnCode parameter is zero. For a list of possible values, see Section 6.1, HTTP Status Codes.
• reserved—Reserved for future use. Currently returns NULL.

Return Values

If successful, returns 0. For an asynchronous request, success means that the parameters are valid and the request has been sent. For a synchronous request, success means that the request has been sent and the reply has been received.

On failure, returns a nonzero error code.

Remarks

You can call the HttpGetReply function immediately after the HttpOpenRequest function if your request doesn't require additional HTTP header tags or data. If called under these conditions, the HttpGetReply function sends the request, receives the reply, and parses the reply header.

The HttpGetReply function can be used synchronously or asynchronously. In synchronous mode, the function blocks until the send is completed and the status is returned. To use this mode, set the pContext and pCallBackRoutine parameters to NULL.

In asynchronous mode, the initial status returns immediately. If it is zero, the request has been accepted and your callback function is called when the reply is received and parsed. If the initial status is nonzero, an error has occurred, the request is not sent, and your callback function is never called.

See Also

• HttpOpenRequest