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

Artigo
08/09/2016

Publicado: junho de 2016

Recupera informações sobre a cadeia de caracteres de composição. Wrapper para uma chamada para ImmGetCompositionString.

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

Sintaxe

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

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

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

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

Parâmetros

HIMC
Type: System.UInt32

[in] Identificador para o contexto IME.

dwIndex
Type: System.UInt32

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

pbstrCompString
Type: System.String

[out] Buffer binário — não uma cadeia de caracteres Unicode. Alocados com SysAllocStringByteLen. Para obter mais informações, consulte ImmSetCompositionString.

e ImmGetCompositionString.

plRetVal
Type: System.Int32

[out] Ponteiro para o valor de retorno. Contém o número de bytes copiados para o buffer de destino ou, se dwBufLen for zero, o tamanho do buffer, em bytes, necessário para receber todas as informações. O tamanho é sempre em bytes, mesmo se os dados solicitados são uma cadeia de caracteres Unicode.

No erro, definido 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 retornará S_OK. Se ele falhar, ele retorna um código de erro.

Comentários

COM assinatura

De vsshell.idl:

HRESULT IVsIME::GetImmCompositionString(
   [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