IVsHTMLConverter.ConvertToURLEncoding Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Converts a string substituting URL encoding where needed, such as "%20" for a space.

public:
 int ConvertToURLEncoding(System::UInt32 uCodePage, System::String ^ szToConvert, System::UInt32 cchBuffSize, cli::array <System::UInt16> ^ szBuffer, [Runtime::InteropServices::Out] System::UInt32 % pcchBuffSizeActual);

int ConvertToURLEncoding(unsigned int uCodePage, std::wstring const & szToConvert, unsigned int cchBuffSize, std::Array <unsigned short> const & szBuffer, [Runtime::InteropServices::Out] unsigned int & pcchBuffSizeActual);

public int ConvertToURLEncoding (uint uCodePage, string szToConvert, uint cchBuffSize, ushort[] szBuffer, out uint pcchBuffSizeActual);

abstract member ConvertToURLEncoding : uint32 * string * uint32 * uint16[] * uint32 -> int

Public Function ConvertToURLEncoding (uCodePage As UInteger, szToConvert As String, cchBuffSize As UInteger, szBuffer As UShort(), ByRef pcchBuffSizeActual As UInteger) As Integer

Parameters

uCodePage

UInt32

[in] The code page to use when converting.

szToConvert

String

[in] String to convert.

cchBuffSize

UInt32

[in] Length of the buffer in which to store the converted string.

szBuffer

UInt16[]

[out] The buffer containing the converted string.

pcchBuffSizeActual

UInt32

[out] Actual size of the buffer used.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsHTMLConverter::ConvertToURLEncoding(  
   [in] UINT uCodePage,   
   [in] LPCOLESTR szToConvert,   
   [in] ULONG cchBuffSize,   
   [in, out, size_is(cchBuffSize)] OLECHAR szBuffer[],   
   [out] ULONG *pcchBuffSizeActual  
);