Método IVsIME.GetImmCompositionStringW (UInt32, UInt32, String, Int32)

Artigo
04/23/2016

Recupera informações sobre a seqüência de caracteres de composição.Wrapper para uma chamada para ImmGetCompositionString.Lida com a seqüência de caracteres como caracteres extensos (wchar_t) em vez de bytes.

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

Sintaxe

int GetImmCompositionStringW(
    uint HIMC,
    uint dwIndex,
    out string pbstrCompString,
    out int plRetVal
)

int GetImmCompositionStringW(
    unsigned int HIMC,
    unsigned int dwIndex,
    [OutAttribute] String^% pbstrCompString,
    [OutAttribute] int% plRetVal
)

abstract GetImmCompositionStringW : 
        HIMC:uint32 *
        dwIndex:uint32 *
        pbstrCompString:string byref *
        plRetVal:int byref -> int

Function GetImmCompositionStringW (
    HIMC As UInteger,
    dwIndex As UInteger,
    <OutAttribute> ByRef pbstrCompString As String,
    <OutAttribute> ByRef plRetVal As Integer
) As Integer

Parâmetros

HIMC
[in] Identificador para o contexto do IME.

dwIndex
[in] Índice das informações para recuperar.Para obter mais informações sobre os valores possíveis, consulte valores de seqüência de caracteres de composição do IME.

pbstrCompString
[out] Caracteres largos (wchar_t, Unicode) buffer.Use o SysAllocStringByteLen e SysStringByteLen para gerenciar a memória para este item.Consulte ImmSetCompositionString e ImmGetCompositionString.

plRetVal
[out] Ponteiro para o valor de retorno.Contém o número de caracteres extensos copiado para o buffer de destino ou então, se dwBufLen é igual a zero, o tamanho do buffer em caracteres de largura, necessários para receber todas as informações.O tamanho é sempre em caracteres de largura.

Sobre o erro, defina como um dos dois valores: IMM_ERROR_NODATA, ou IMM_ERROR_GENERAL.

Valor de retorno

Type: System.Int32

Se o método for bem-sucedido, ele retorna S_OK.Se ele falhar, ele retorna um código de erro.

Comentários

COM assinatura

De vsshell.idl:

HRESULT IVsIME::GetImmCompositionStringW( 
   [in] HIMC himc, 
   [in] DWORD dwIndex, 
   [out] BSTR *pbstrCompString, 
   [out] LONG * plRetVal
);

Consulte também

Interface IVsIME
Namespace Microsoft.VisualStudio.Shell.Interop

Retornar ao topo

Partilhar via