Funzione ImmGetCompositionStringA (immdev.h)
Recupera informazioni sulla stringa di composizione.
Sintassi
LONG ImmGetCompositionStringA(
HIMC unnamedParam1,
DWORD unnamedParam2,
[out, optional] LPVOID lpBuf,
[in] DWORD dwBufLen
);
Parametri
unnamedParam1
unnamedParam2
[out, optional] lpBuf
Puntatore a un buffer in cui la funzione recupera le informazioni sulla stringa di composizione.
[in] dwBufLen
Dimensioni, in byte, del buffer di output, anche se l'output è una stringa Unicode. L'applicazione imposta questo parametro su 0 se la funzione deve restituire le dimensioni del buffer di output richiesto.
Valore restituito
Restituisce il numero di byte copiati nel buffer di output. Se dwBufLen è impostato su 0, la funzione restituisce le dimensioni del buffer, in byte, necessarie per ricevere tutte le informazioni richieste, escluso il carattere Null di terminazione. Il valore restituito è sempre la dimensione, in byte, anche se i dati richiesti sono una stringa Unicode.
Questa funzione restituisce uno dei codici di errore negativi seguenti se non riesce:
- IMM_ERROR_NODATA. I dati di composizione non sono pronti nel contesto di input.
- IMM_ERROR_GENERAL. Errore generale rilevato da IME.
Commenti
Un'applicazione chiama questa funzione in risposta al messaggio WM_IME_COMPOSITION o WM_IME_STARTCOMPOSITION . IMM rimuove le informazioni quando l'applicazione chiama la funzione ImmReleaseContext .
Nota
L'intestazione immdev.h definisce ImmGetCompositionString come alias che seleziona automaticamente la versione ANSI o Unicode di questa funzione in base alla definizione della costante preprocessore UNICODE. La combinazione dell'utilizzo dell'alias di codifica neutrale con il codice che non è neutrale dalla codifica può causare errori di corrispondenza che causano errori di compilazione o runtime. Per altre informazioni, vedere Convenzioni per i prototipi di funzione.
Requisiti
| Client minimo supportato | Windows XP [solo app desktop], supporto per la lingua asiatica orientale installato. |
| Server minimo supportato | Windows Server 2003 [solo app desktop] |
| Piattaforma di destinazione | Windows |
| Intestazione | immdev.h (includono Immdev.h, Windows.h) |
| Libreria | Imm32.lib |
| DLL | Imm32.dll |