IVsHTMLConverter.ConvertToEntities(String, UInt32, UInt16[], UInt32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Converts a character string to one containing entity references such "ä" for the character "ä."

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

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

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

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

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

Parameters

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::ConvertToEntities(  
   [in] LPCOLESTR szToConvert,   
   [in] ULONG cchBuffSize,   
   [in, out, size_is(cchBuffSize)] OLECHAR szBuffer[],   
   [out] ULONG *pcchBuffSizeActual  
);

Applies to

Share via