URL_COMPONENTSA structure (wininet.h)
Contains the constituent parts of a URL. This structure is used with the InternetCrackUrl and InternetCreateUrl functions.
Syntax
typedef struct {
DWORD dwStructSize;
LPSTR lpszScheme;
DWORD dwSchemeLength;
INTERNET_SCHEME nScheme;
LPSTR lpszHostName;
DWORD dwHostNameLength;
INTERNET_PORT nPort;
LPSTR lpszUserName;
DWORD dwUserNameLength;
LPSTR lpszPassword;
DWORD dwPasswordLength;
LPSTR lpszUrlPath;
DWORD dwUrlPathLength;
LPSTR lpszExtraInfo;
DWORD dwExtraInfoLength;
} URL_COMPONENTSA, *LPURL_COMPONENTSA;
Members
dwStructSize
Size of this structure, in bytes.
lpszScheme
Pointer to a string that contains the scheme name.
dwSchemeLength
Size of the scheme name, in TCHARs.
nScheme
INTERNET_SCHEME value that indicates the Internet protocol scheme.
lpszHostName
Pointer to a string that contains the host name.
dwHostNameLength
Size of the host name, in TCHARs.
nPort
Converted port number.
lpszUserName
Pointer to a string value that contains the user name.
dwUserNameLength
Size of the user name, in TCHARs.
lpszPassword
Pointer to a string that contains the password.
dwPasswordLength
Size of the password, in TCHARs.
lpszUrlPath
Pointer to a string that contains the URL path.
dwUrlPathLength
Size of the URL path, in TCHARs.
lpszExtraInfo
Pointer to a string that contains the extra information (for example, ?something or #something).
dwExtraInfoLength
Size of the extra information, in TCHARs.
Remarks
For InternetCrackUrl, if a pointer member and its corresponding length member are both zero, that component is not returned. If the pointer member is NULL but the length member is not zero, both the pointer and length members are returned. If both pointer and corresponding length members are nonzero, the pointer member points to a buffer where the component is copied. The component can be un-escaped, depending on the dwFlags parameter of InternetCrackUrl.
For InternetCreateUrl, the pointer members should be NULL if the component is not required. If the corresponding length member is zero, the pointer member is the address of a zero-terminated string. If the length member is not zero, it is the string length of the corresponding pointer member.
Note
The wininet.h header defines URL_COMPONENTS as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.
Requirements
Requirement | Value |
---|---|
Minimum supported client | Windows 2000 Professional [desktop apps only] |
Minimum supported server | Windows 2000 Server [desktop apps only] |
Header | wininet.h |