TranslateURL Function

Applies common translations to a given URL string, creating a new URL string.

Syntax

HRESULT WINAPI TranslateURL(
    LPCSTR pcszURL,
    DWORD dwInFlags,
    LPSTR *ppszTranslatedURL
);

Parameters

pcszURL

Address of the URL string to be translated.

dwInFlags

Bit flags that specify how the URL string is to be translated. This value can be a combination of the following:

TRANSLATEURL_FL_GUESS_PROTOCOL	If the protocol scheme is not specified in the pcszURL parameter to TranslateURL, the system automatically chooses a scheme and adds it to the URL.
TRANSLATEURL_FL_USE_DEFAULT_PROTOCOL	If the protocol scheme is not specified in the pcszURL parameter to TranslateURL, the system adds the default protocol to the URL.

ppszTranslatedURL

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

Returns one of the following values:

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:

E_FLAGS	The flag combination passed in dwInFlags is invalid.
E_OUTOFMEMORY	There was insufficient memory to complete the operation.
E_POINTER	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.

Does this content meet your programming needs? Write us!

Back to top