CHttpFile
CObject |
└CFile |
└CStdioFile |
└CInternetFile |
└CHttpFile |
CHttpFile提供向HTTP服务器中请求和读取的功能。
如果Internet会话要从一个HTTP服务器中读取数据,则必须构造一个CHttpFile实例。
#include <afxinet.h>
CHttpFile类的成员
构造函数
CHttpFile | 构造一个CHttpFile对象 |
操作
AddRequestHeaders | 添加发往HTTP服务器的请求头 |
SendRequest | 向HTTP服务器发送请求 |
SendRequestEx | 利用CInternetFile的Write或WriteString方法向HTTP服务器发送请求 |
EndRequest | 利用EndRequestEx的成员函数结束HTTP服务器的请求 |
QueryInfo | 返回来自HTTP服务器的回答或请求头 |
QueryInfoStatusCode | 获取与HTTP请求相关联的状态号,并将其放到提供的dwStatusCode 参数中 |
GetVerb | 获取用于对HTTP服务器的请求的动词 |
GetObject | 获取对HTTP服务器的请求中的动词的目标对象 |
GetFileURL | 获取指定文件的URL |
Close | 关闭CHttpFile并释放其资源 |
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 );
返回值:
如果成功,则返回非零值,否则为0。如果该调用失败,Win32的函数GetLastError 会被调用,确定失败的原因。
参数:
pstrHeaders | 一个指向某字符串的指针,该字符串包含添加到请求中的头。每个头都必须以CR/LF结束。 | ||||||||||||
dwFlags | 修改新头部的语义。可能为以下几种之一:
| ||||||||||||
dwHeadersLen | pstrHeaders的长度,以字符计算。如果为-1L,则pstrHeaders被假定为是空终止的,且长度已被计算出来了。 | ||||||||||||
str | 一个CString对象的参考,包含请求头或者将被添加的头。 |
说明:
调用该成员函数,用来对HTTP请求操作添加一个或多个请求头。AddRequestHeaders 增加附加的、形式自由的头到HTTP请求操作中。其往往被高级客户使用,他们需要对发往HTTP服务器的指定的请求进行具体控制。
注意:
对于使用HTTP_ADDREQ_FLAG_ADD或者HTTP_ADDREQ_FLAG_ADD_IF_NEW对AddRequestHeaders的调用,应用可在pstrHeaders 或str中,一次传递多个头。如果应用试图使用HTTP_ADDREQ_FLAG_REMOVE或HTTP_ADDREQ _FLAG_REPLACE来移动或替换一个头,则lpszHeaders中只能提供一个头。
CHttpFile::CHttpFile
CHttpFile( HINTERNET hFile, HINTERNET hSession, LPCTSTR pstrObject, LPCTSTR pstrServer, LPCTSTR pstrVerb, DWORD dwContext );
CHttpFile( HINTERNET hFile, LPCTSTR pstrVerb, LPCTSTR pstrObject, CHttpConnection* pConnection );
参数:
hFile | Internet文件的句柄。 |
hSession | Internet会话的句柄。 |
pstrObject | 一个指向包含CHttpFile对象名称的字符串的指针。 |
pstrServer | 一个指向包含服务器名称的字符串的指针。 |
pstrVerb | 一个指向某字符串的指针,该字符串包含在发送请求时将要使用的方法,可能为POST,HEAD或GET。 |
dwContext | 一个CHttpFile对象的上下文标识符。请参阅说明,以了解有关该参数的更多信息。 |
pConnection | 一个指向CHttpConnection对象的指针。 |
说明:
调用该成员函数来构造一个CHttpFile对象。
不能直接构造一个CHttpFile对象,但可以调用CInternetSession::OpenURL 或CHttpConnection::OpenRequest。
dwContext的缺省值由MFC从创建此CHttpFile对象的CInternetSession对象发送到CHttpFile对象。当调用CInternetSession::OpenURL 或CHttpConnection 来构造一个CHttpFile对象时,可覆盖此缺省值,来设置你所选择的值的上下文标识符。上下文标识符返回到CInternetSession::OnStatusCallback ,提供其所代表的对象状态。
CHttpFile::Close
virtual void Close( );
说明:
关闭CHttpFile 并释放其资源。只有在对SendRequest的成功调用或者一个CHttpFile对象被 OpenURL成功创建后,才能使用该成员函数。
CHttpFile::EndRequest
BOOL EndRequest(DWORD dwFlags = 0, LPINTERNET_BUFFERS lpBuffln = NULL, DWORD dwContext = 1);
throw(CInternetException);
返回值:
如果成功,则返回非零值,否则为0。如果此调用失败,可通过检查产生的CInternetException对象来确定错误原因。
参数:
dwFlags | 描述此操作的标记。要了解适当标记的列表,请参阅联机文档“平台SDK”中的HttpEndRequest。 |
lpBuffIn | 指向描述此操作的输入缓冲区的初始INTERNET_BUFFERS的指针。 |
dwContext | CHttpFile操作的上下文标识符。请参阅说明,以了解此参数的更多信息。 |
说明:
调用此成员函数来结束用成员函数发送HTTP服务器的请求。
dwContext的缺省值由MFC从创建此CHttpFile对象的CInternetSession对象发送到CHttpFile对象。当调用CInternetSession::OpenURL 或CHttpConnection 来构造一个CHttpFile对象时,可覆盖此缺省值,来设置你所选择的值的上下文标识符。上下文标识符返回到CInternetSession::OnStatusCallback ,提供其所代表的对象状态。
CHttpFile::GetFileURL
virtual CString GetFileURL( ) const;
返回值:
一个CString对象,包含一个参照与本文件相关联资源的URL。
说明:
调用该成员函数,得到以URL表示的HTTP文件的名字。只有在对SendRequest的成功调用或者一个CHttpFile对象被OpenURL成功创建后,才能使用该成员函数。
CHttpFile::GetObject
CString GetObject( ) const;
返回值:一个包含对象名称的CString对象。
说明:
调用该成员函数以了解与此CHttpFile相关联的对象名称。只有在对SendRequest的成功调用或者一个CHttpFile对象被OpenURL成功创建后,才能使用该成员函数。
CHttpFile::GetVerb
CString GetVerb( ) const;
返回值:一个包含HTTP动词名的CString对象。
说明:
调用该成员函数以了解与此CHttpFile相关联的HTTP动词。只有在SendRequest 被成功调用或者一个CHttpFile对象被 OpenURL成功创建后,才能使用该成员函数。
CHttpFile::QueryInfo
BOOL QueryInfo( DWORD dwInfoLevel, LPVOID lpvBuffer, LPDWORD lpdwBufferLength, LPDWORD lpdwIndex = NULL ) const;
BOOL QueryInfo( DWORD dwInfoLevel, CString& str, LPDWORD dwIndex = NULL) const;
BOOL QueryInfo( DWORD dwInfoLevel, SYSTEMTIME* pSysTime, LPDWORD dwIndex = NULL ) const;
返回值:
如果成功,则返回非零值,否则为0。如果此调用失败,可通过调用Win32的函数GetLastError来确定错误原因。
参数:
dwInfoLevel | 查询属性和下列指定所须信息标志的组合:
| ||||||||||||
lpvBuffer | 一个指向用于接收信息的缓冲区的指针。 | ||||||||||||
lpdwBufferLength | 在入口处,这是指向一个用字节或位表示的包含数据缓冲区长度的值。请参阅说明部分以了解此参数的详细信息。 | ||||||||||||
lpdwIndex | 一个指向基于零的头索引的指针。可以为NULL。使用此标记来枚举同名的多个头。对于输入,lpdwIndex表示返回的指定的头的索引。对于输出,lpdwIndex 表示下一个头的索引。如果此索引找不到,则返回ERROR_HTTP_HEADER_NOT_FOUND。 | ||||||||||||
str | 接收返回信息的CString对象的参考值。 | ||||||||||||
dwIndex | 一个索引值。请参阅lpdwIndex。 | ||||||||||||
pSysTime | 一个指向Win32 SYSTEMTIME结构的指针。 |
说明:
调用此成员函数返回HTTP请求中的回答或请求头。只有在SendRequest被成功调用或者一个CHttpFile对象被 OpenURL成功创建后,才能使用该成员函数。
你可从QueryInfo中获取以下数据类型:
· | strings (缺省) |
· | SYSTEMTIME (对于“Data:”“Expires:”等) |
· | DWORD (对于 STATUS_CODE,CONTENT_LENGTH等等) |
可能的dwInfoLevel值包括:
· | HTTP_QUERY_MIME_VERSION |
· | HTTP_QUERY_CONTENT_TYPE |
· | HTTP_QUERY_CONTENT_TRANSFER_ENCODING |
· | HTTP_QUERY_CONTENT_ID |
· | HTTP_QUERY_CONTENT_DESCRIPTION |
· | HTTP_QUERY_CONTENT_LENGTH |
· | HTTP_QUERY_ALLOWED_METHODS |
· | HTTP_QUERY_PUBLIC_METHODS |
· | HTTP_QUERY_DATE |
· | HTTP_QUERY_EXPIRES |
· | HTTP_QUERY_LAST_MODIFIED |
· | HTTP_QUERY_MESSAGE_ID |
· | HTTP_QUERY_URI |
· | HTTP_QUERY_DERIVED_FROM |
· | HTTP_QUERY_LANGUAGE |
· | HTTP_QUERY_COST |
· | HTTP_QUERY_WWW_LINK |
· | HTTP_QUERY_PRAGMA |
· | HTTP_QUERY_VERSION |
· | HTTP_QUERY_STATUS_CODE |
· | HTTP_QUERY_STATUS_TEXT |
· | HTTP_QUERY_RAW_HEADERS |
· | HTTP_QUERY_RAW_HEADERS_CRLF |
CHttpFile::QueryInfoStatusCode
BOOL QueryInfoStatusCode( DWORD& dwStatusCode ) const;
返回值:
如果成功,则返回非零值,否则为0。如果此调用失败,可通过调用Win32的函数GetLastError来确定错误原因。
参数:
dwStatusCode | 状态号的参考值。状态号标识请求事件是成功还是失败。请参阅说明部分,以了解状态号的细节。 |
说明:
调用此成员函数以获得HTTP请求相关联的状态号并将其放到所提供的dwStatusCode 参数中。只有在SendRequest 被成功调用或者一个CHttpFile对象被 OpenURL成功创建后,才能使用该成员函数。
分组的HTTP 状态号标识请求的成功或失败。以下列表列出了状态号组及大部分常用状态号。
分组 | 含义 |
200-299 | 成功 |
300-399 | 信息 |
400-499 | 请求错误 |
500-599 | 服务器错误 |
状态号 | 含义 |
200 | URL定位,接着传输 |
400 | 不可理解的请求 |
404 | 所请求的URL未找到 |
405 | 服务器不支持所请求的方法 |
500 | 未知的服务器错误 |
503 | 已达到服务器容量 |
CHttpFile::SendRequest
BOOL SendRequest( LPCTSTR pstrHeaders = NULL, DWORD dwHeadersLen = 0, LPVOID lpOptional = NULL, DWORD dwOptionalLen= 0 );
throw(CInternetException);
BOOL SendRequest( CString& strHeaders, LPVOID lpOptional = NULL, DWORD dwOptionalLen = 0 );
throw(CInternetException);
返回值:
如果成功,则返回非零值,否则为0。如果此调用失败,可通过检查产生的CInternetException对象来确定错误原因。
参数:
pstrHeaders | 一个指向包含着要发送的头名称的字符串的指针。 |
dwHeadersLen | 由pstrHeaders指定的头的长度。 |
lpOptional | 在请求头后立即发送的任意选项数据。通常用于POST和PUT操作。如果没有待发送的选项数据,则可能为NULL。 |
dwOptionalLen | lpOptional的长度。 |
strHeaders | 一个包含着正被发送的请求的头名称的字符串。 |
说明:调用此成员函数以向HTTP服务器发送请求。
CHttpFile::SendRequestEx
BOOL SendRequestEx(DWORD dwTotalLen, DWORD dwFlags = HSR_INITIATE, DWORD dwContext = 1);
throw(CInternetException);
BOOL SendRequestEx(LPINTERNET_BUFFERS lpBuffIn, LPINTERNET_BUFFERS lpBuffOut, DWORD dwFlags = HSR_INITIATE, DWORD dwContext = 1);
throw(CInternetException);
返回值:
如果成功,则返回非零值,否则为0。如果此调用失败,可通过检查产生的CInternetException对象来确定错误原因。
参数:
dwTotalLen | 请求中将被发送的字节数。 |
dwFlags | 描述操作的标记。要了解适当标记的列表,请参阅联机文档“平台SDK”中的HttpSendRequstEx。 |
dwContext | CHttpFile操作的上下文标识符。请参阅说明部分关于此参数的更多信息。 |
lpBuffIn | 一个指向描述操作中用到的输入缓冲区的初始化了的INTERNET_BUFFERS的指针。 |
lpBufferOut | 一个指向描述操作中用到的输出缓冲区的初始化了的INTERNET_BUFFERS的指针。 |
说明:
调用此成员函数来向一个HTTP 服务器发送请求。此函数允许应用使用CInternetFile的Write和WriteString 来发送数据。在调用任一此函数的覆盖前,必须知道发送的数据长度。第一个覆盖允许确定你要发送的数据长度。第二个覆盖接收指向INTERNET_BUFFERS结构的指针,它可以用来详细地描述缓冲区。
当内容已被写入文件时,调用EndRequest来结束此操作。
dwContext的缺省值由MFC从创建此CHttpFile对象的CInternetSession对象发送到CHttpFile对象。当调用CInternetSession::OpenURL 或CHttpConnection 来构造一个CHttpFile对象时,可覆盖此缺省值,来设置你所选择的值的上下文标识符。上下文标识符返回到CInternetSession::OnStatusCallback ,提供其所代表的对象状态。请参阅联机文档“Visual C++程序员指南”中的“Internet初步:WinInet”,以了解有关上下文标识符的更多信息。
示例:
此代码段发送一个字符串的内容到名为ISAPI的DLL 中,DLL在服务器中为MOOSEBOY。此示例对WriteString的调用只有一个,但可以使用多个来发送成块数据。
CString strData = "Some very long data to be POSTed here!";
pServer = sess.GetHttpConnection("mooseboy");
pFile = pServer->OpenRequest(CHttpConnection::HTTP_VERB_POST, "/isapi.dll?");
pFile->SendRequestEx(strData.GetLength());
pFile->WriteString(strData);
pFile->EndRequest();