CHttpFile::AddRequestHeaders

BOOL AddRequestHeaders( LPCTSTR pstrHeaders, DWORD dwFlags = HTTP_ADDREQ_FLAG_ADD_IF_NEW, int dwHeadersLen = -1 );

BOOL AddRequestHeaders( CString& str, DWORD dwFlags = HTTP_ADDREQ_FLAG_ADD_IF_NEW );

Return Value

Nonzero if successful; otherwise 0. If the call fails, the Win32 function GetLastError may be called to determine the cause of the error.

Parameters

pstrHeaders

A pointer to a string containing the header or headers to append to the request. Each header must be terminated by a CR/LF pair.

dwFlags

Modifies the semantics of the new headers. Can be one of the following:

• HTTP_ADDREQ_FLAG_COALESCE   Merges headers of the same name, using the flag to add the first header found to the subsequent header. For example, "Accept: text/*" followed by "Accept: audio/*" results in the formation of the single header "Accept: text/*, audio/*". It is up to the calling application to ensure a cohesive scheme with respect to data received by requests sent with coalesced or separate headers.
  
  
• HTTP_ADDREQ_FLAG_REPLACE   Performs a remove and add to replace the current header. The header name will be used to remove the current header, and the full value will be used to add the new header. If the header-value is empty and the header is found, it is removed. If not empty, the header-value is replaced.
  
  
• HTTP_ADDREQ_FLAG_ADD_IF_NEW   Only adds the header if it does not already exist. If one exists, an error is returned.
  
  
• HTTP_ADDREQ_FLAG_ADD   Used with REPLACE. Adds the header if it doesn’t exist.

dwHeadersLen

The length, in characters, of pstrHeaders. If this is -1L, then pstrHeaders is assumed to be zero-terminated and the length is computed.

str

A reference to a CString object containing the request header or headers to be added.

Remarks

Call this member function to add one or more HTTP request headers to the HTTP request handle.

AddRequestHeaders appends additional, free-format headers to the HTTP request handle. It is intended for use by sophisticated clients who need detailed control over the exact request sent to the HTTP server.

Note   The application can pass multiple headers in pstrHeaders or str for an AddRequestHeaders call using HTTP_ADDREQ_FLAG_ADD or HTTP_ADDREQ_FLAG_ADD_IF_NEW. If the application tries to remove or replace a header using HTTP_ADDREQ_FLAG_REMOVE or HTTP_ADDREQ_FLAG_REPLACE, only one header can be supplied in lpszHeaders.

CHttpFile Overview |  Class Members |  Hierarchy Chart

See Also   CInternetFile