TranslateURL function
Applies common translations to a given URL string, creating a new URL string.
Syntax
HRESULT TranslateURL( PCTSTR pcszURL, DWORD dwInFlags, _Out_ PTSTR *ppszTranslatedURL );
Parameters
- pcszURL
-
Type: PCTSTR
The address of the URL string to be translated.
- dwInFlags
-
Type: DWORD
The bit flags that specify how the URL string is to be translated. This value can be a combination of the following:
- ppszTranslatedURL [out]
-
Type: PTSTR*
A pointer variable that receives the pointer to the newly created, translated URL string, if any. The ppszTranslatedURL parameter is valid only if the function returns S_OK.
Return value
Type: HRESULT
Returns S_OK upon success, or S_FALSE if the URL did not require translation. If an error occurs, the function returns one of the following values.
| Return code | Description |
|---|---|
|
The flag combination passed in dwInFlags is invalid. |
|
There was insufficient memory to complete the operation. |
|
One of the input pointers is invalid. |
Remarks
This function does not validate the input URL string. A successful return value does not indicate that the URL strings are valid URLs.
Requirements
|
Minimum supported client |
Windows XP [desktop apps only] |
|---|---|
|
Minimum supported server |
Windows 2000 Server [desktop apps only] |
|
Header |
|
|
DLL |
|
|
Unicode and ANSI names |
TranslateURLW (Unicode) and TranslateURLA (ANSI) |