IVsHTMLConverter.ConvertToEntities Method

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

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

Syntax

'Declaration
Function ConvertToEntities ( _
    szToConvert As String, _
    cchBuffSize As UInteger, _
    <OutAttribute> szBuffer As UShort(), _
    <OutAttribute> ByRef pcchBuffSizeActual As UInteger _
) As Integer
'Usage
Dim instance As IVsHTMLConverter
Dim szToConvert As String
Dim cchBuffSize As UInteger
Dim szBuffer As UShort()
Dim pcchBuffSizeActual As UInteger
Dim returnValue As Integer

returnValue = instance.ConvertToEntities(szToConvert, _
    cchBuffSize, szBuffer, pcchBuffSizeActual)

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

int ConvertToEntities(
    [InAttribute] String^ szToConvert, 
    [InAttribute] unsigned int cchBuffSize, 
    [OutAttribute] array<unsigned short>^ szBuffer, 
    [OutAttribute] unsigned int% pcchBuffSizeActual
)

abstract ConvertToEntities : 
        szToConvert:string * 
        cchBuffSize:uint32 * 
        szBuffer:uint16[] byref * 
        pcchBuffSizeActual:uint32 byref -> int

function ConvertToEntities(
    szToConvert : String, 
    cchBuffSize : uint, 
    szBuffer : ushort[], 
    pcchBuffSizeActual : uint
) : int

Parameters

szToConvert
Type: System.String
[in] String to convert.

cchBuffSize
Type: System.UInt32
[in] Length of the buffer in which to store the converted string.

szBuffer
Type: array<System.UInt16[]
[out] The buffer containing the converted string.

pcchBuffSizeActual
Type: System.UInt32%
[out] Actual size of the buffer used.

Return Value

Type: System.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
);

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.