ConvertINetString function

Article
11/05/2015

[ConvertINetString is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions. Instead, use MultiByteToWideChar or WideCharToMultiByte. ]

Performs character set conversion between a given source code page identifier and a destination code page identifier.

Syntax

HRESULT ConvertINetString(
   LPDWORD lpdwMode,
   DWORD   dwSrcEncoding,
   DWORD   dwDstEncoding,
   LPCSTR  lpSrcStr,
   LPINT   lpnSrcSize,
   LPBYTE  lpDstStr,
   LPINT   lpnDstSize
);

Parameters

lpdwMode
A pointer to a DWORD that is used internally to store conversion context. A caller should provide storage that is initialized with zero at the first call to the function. A caller must not modify the value without calling MLANG service functions.
dwSrcEncoding
A DWORD that contains the code page identifier value for the source string.
dwDstEncoding
A DWORD that contains the code page identifier value for the destination string.
lpSrcStr
A pointer to the string that is being converted.
lpnSrcSize
A pointer to the buffer that stores the length of the source string in bytes. If this is NULL, or if the length specified is -1, the function assumes that the source string is null-terminated. When the conversion is successful, the function returns the number of bytes processed to this buffer.
lpDstStr
A pointer to the string buffer where the conversion result is stored.
lpnDstSize
A pointer to the buffer that stores the length of the destination string in bytes. When the conversion is successful, the function returns the number of bytes copied to the lpDstStr buffer.

Return value

The function returns one of the following values.

Return code	Description
S_OK	Performed the conversion successfully.
S_FALSE	The specified conversion is not supported on the system.
E_FAIL	An error has occurred.

Remarks

An application calls this function to convert a character stream in an Internet character set to a Windows code page, or vice versa. This function provides a conversion similar to the conversion performed by calling IMultiLanguage::ConvertString.

Requirements

Minimum supported client	Windows XP
Minimum supported server	Windows 2000 Server
Header	Mlang.h
DLL	Mlang.dll

Share via