Internet URL Parsing Globals and Helpers

When a client sends a query to the Internet server, you can use one of the URL parsing globals to extract information about the client. The helper functions provide other internet functionality.

Internet URL Parsing Globals

AfxParseURL Parses a URL string and returns the type of service and its components.
AfxParseURLEx Parses a URL string and returns the type of service and its components, as well as providing the user name and password.

Other Internet Helpers

AfxThrowInternetException Throws an exception related to the internet connection.
AfxGetInternetHandleType Determines the type of an Internet handle.

AfxParseURL

This global is used in CInternetSession::OpenURL.

BOOL AFXAPI AfxParseURL(
    LPCTSTR pstrURL,
    DWORD& dwServiceType,
    CString& strServer,
    CString& strObject,
    INTERNET_PORT& nPort);

Parameters

pstrURL
A pointer to a string containing the URL to be parsed.

dwServiceType
Indicates the type of Internet service. Possible values are as follows:

  • AFX_INET_SERVICE_FTP

  • AFX_INET_SERVICE_HTTP

  • AFX_INET_SERVICE_HTTPS

  • AFX_INET_SERVICE_GOPHER

  • AFX_INET_SERVICE_FILE

  • AFX_INET_SERVICE_MAILTO

  • AFX_INET_SERVICE_NEWS

  • AFX_INET_SERVICE_NNTP

  • AFX_INET_SERVICE_TELNET

  • AFX_INET_SERVICE_WAIS

  • AFX_INET_SERVICE_MID

  • AFX_INET_SERVICE_CID

  • AFX_INET_SERVICE_PROSPERO

  • AFX_INET_SERVICE_AFS

  • AFX_INET_SERVICE_UNK

strServer
The first segment of the URL following the service type.

strObject
An object that the URL refers to (may be empty).

nPort
Determined from either the Server or Object portions of the URL, if either exists.

Return Value

Nonzero if the URL was successfully parsed; otherwise, 0 if it is empty or does not contain a known Internet service type.

Remarks

It parses a URL string and returns the type of service and its components.

For example, AfxParseURL parses URLs of the form service://server/dir/dir/object.ext:port and returns its components stored as follows:

strServer == "server"

strObject == "/dir/dir/object/object.ext"

nPort == #port

dwServiceType == #service

Note

To call this function, your project must include AFXINET.H.

Requirements

Header afxinet.h

AfxParseURLEx

This global function is the extended version of AfxParseURL and is used in CInternetSession::OpenURL.

BOOL AFXAPI AfxParseURLEx(
    LPCTSTR pstrURL,
    DWORD& dwServiceType,
    CString& strServer,
    CString& strObject,
    INTERNET_PORT& nPort,
    CString& strUsername,
    CString& strPassword,
    DWORD dwFlags = 0);

Parameters

pstrURL
A pointer to a string containing the URL to be parsed.

dwServiceType
Indicates the type of Internet service. Possible values are as follows:

  • AFX_INET_SERVICE_FTP

  • AFX_INET_SERVICE_HTTP

  • AFX_INET_SERVICE_HTTPS

  • AFX_INET_SERVICE_GOPHER

  • AFX_INET_SERVICE_FILE

  • AFX_INET_SERVICE_MAILTO

  • AFX_INET_SERVICE_NEWS

  • AFX_INET_SERVICE_NNTP

  • AFX_INET_SERVICE_TELNET

  • AFX_INET_SERVICE_WAIS

  • AFX_INET_SERVICE_MID

  • AFX_INET_SERVICE_CID

  • AFX_INET_SERVICE_PROSPERO

  • AFX_INET_SERVICE_AFS

  • AFX_INET_SERVICE_UNK

strServer
The first segment of the URL following the service type.

strObject
An object that the URL refers to (may be empty).

nPort
Determined from either the Server or Object portions of the URL, if either exists.

strUsername
A reference to a CString object containing the name of the user.

strPassword
A reference to a CString object containing the password of the user.

dwFlags
The flags controlling how to parse the URL. Can be a combination of the following values:

Value Meaning
ICU_DECODE Convert %XX escape sequences to characters.
ICU_NO_ENCODE Do not convert unsafe characters to escape sequence.
ICU_NO_META Do not remove meta sequences (such as "\ ." and "\ ..") from the URL.
ICU_ENCODE_SPACES_ONLY Encode spaces only.
ICU_BROWSER_MODE Do not encode or decode characters after '#' or '', and do not remove trailing white space after ''. If this value is not specified, the entire URL is encoded and trailing white space is removed.

If you use the MFC default, which is no flags, the function converts all unsafe characters and meta sequences (such as \.,\ .., and \...) to escape sequences.

Return Value

Nonzero if the URL was successfully parsed; otherwise, 0 if it is empty or does not contain a known Internet service type.

Remarks

It parses a URL string and returns the type of service and its components, as well as providing the user's name and password. The flags indicate how unsafe characters are handled.

Note

To call this function, your project must include AFXINET.H.

Requirements

Header afxinet.h

AfxGetInternetHandleType

Use this global function to determine the type of an Internet handle.

Syntax

DWORD AFXAPI AfxGetInternetHandleType(  HINTERNET hQuery );

Parameters

hQuery
A handle to an Internet query.

Return Value

Any of the Internet service types defined by WININET.H. See the Remarks section for a list of these Internet services. If the handle is NULL or not recognized, the function returns AFX_INET_SERVICE_UNK.

Remarks

The following list includes possible Internet types returned by AfxGetInternetHandleType.

  • INTERNET_HANDLE_TYPE_INTERNET

  • INTERNET_HANDLE_TYPE_CONNECT_FTP

  • INTERNET_HANDLE_TYPE_CONNECT_GOPHER

  • INTERNET_HANDLE_TYPE_CONNECT_HTTP

  • INTERNET_HANDLE_TYPE_FTP_FIND

  • INTERNET_HANDLE_TYPE_FTP_FIND_HTML

  • INTERNET_HANDLE_TYPE_FTP_FILE

  • INTERNET_HANDLE_TYPE_FTP_FILE_HTML

  • INTERNET_HANDLE_TYPE_GOPHER_FIND

  • INTERNET_HANDLE_TYPE_GOPHER_FIND_HTML

  • INTERNET_HANDLE_TYPE_GOPHER_FILE

  • INTERNET_HANDLE_TYPE_GOPHER_FILE_HTML

  • INTERNET_HANDLE_TYPE_HTTP_REQUEST

Note

In order to call this function, your project must include AFXINET.H.

Requirements

Header: afxinet.h

AfxThrowInternetException

Throws an Internet exception.

Syntax

   void AFXAPI AfxThrowInternetException(  DWORD dwContext,  DWORD dwError = 0 );

Parameters

dwContext
The context identifier for the operation that caused the error. The default value of dwContext is specified originally in CInternetSession and is passed to CInternetConnection- and CInternetFile-derived classes. For specific operations performed on a connection or a file, you usually override the default with a dwContext of your own. This value then is returned to CInternetSession::OnStatusCallback to identify the specific operation's status.

dwError
The error that caused the exception.

Remarks

You are responsible for determining the cause based on the operating-system error code.

Note

To call this function, your project must include AFXINET.H.

Requirements

Header: afxinet.h

See also

Macros and Globals
CInternetException Class
AfxParseURL