Funzione RtlUnicodeStringCopyStringEx (ntstrsafe.h)
La funzione RtlUnicodeStringCopyStringEx copia una stringa in una struttura UNICODE_STRING.
Sintassi
NTSTRSAFEDDI RtlUnicodeStringCopyStringEx(
[out] PUNICODE_STRING DestinationString,
[in] NTSTRSAFE_PCWSTR pszSrc,
[out, optional] PUNICODE_STRING RemainingString,
[in] DWORD dwFlags
);
Parametri
[out] DestinationString
Opzionale. Puntatore a una struttura UNICODE_STRING che riceve la stringa copiata. La stringa a cui punta il parametro pszSrc (escluso il valore Null di terminazione) viene copiata nel buffer a cui punta la struttura UNICODE_STRING del parametro DestinationStr ing. Il numero massimo di byte nella stringa è NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR).
DestinationString può essere NULL, ma solo se STRSAFE_IGNORE_NULLS è impostato in dwFlags.
[in] pszSrc
Opzionale. Puntatore a una stringa con terminazione Null che verrà copiata nel buffer a cui punta la struttura UNICODE_STRING del parametro DestinationStr ing. pszSrc può essere NULL, ma solo se STRSAFE_IGNORE_NULLS è impostato in dwFlags.
[out, optional] RemainingString
Opzionale. Se il chiamante fornisce un puntatore NULL nonNULL a una struttura UNICODE_STRING, la funzione imposta il membro Buffer alla fine della stringa concatenata, imposta il membro Length della struttura su zero e imposta il membro MaximumLength della struttura sul numero di byte rimanenti nel buffer di destinazione. RemainingString può essere NULL, ma solo se STRSAFE_IGNORE_NULLS è impostato in dwFlags.
[in] dwFlags
Uno o più flag e, facoltativamente, un byte di riempimento. I flag sono definiti come segue:
| Valore | Significato |
|---|---|
| STRSAFE_FILL_BEHIND | Se questo flag è impostato e la funzione ha esito positivo, il byte basso di dwFlags viene usato per riempire la parte del buffer di destinazione che segue l'ultimo carattere nella stringa. |
| STRSAFE_IGNORE_NULLS | Se questo flag è impostato, il puntatore di origine o di destinazione o entrambi può essere NULL. RtlUnicodeStringCopyStringEx tratta NULL puntatori al buffer di origine come stringhe vuote (TEXT("")), che possono essere copiate. i puntatori del buffer di destinazione null non possono ricevere stringhe non vuoti. |
| STRSAFE_FILL_ON_FAILURE | Se questo flag è impostato e la funzione ha esito negativo, viene usato il byte basso di dwFlags per riempire l'intero buffer di destinazione. Questa operazione sovrascrive qualsiasi contenuto preesistente del buffer. |
| STRSAFE_NULL_ON_FAILURE | Se questo flag è impostato e la funzione ha esito negativo, il buffer di destinazione viene impostato su una stringa vuota (TEXT("")). Questa operazione sovrascrive qualsiasi contenuto preesistente del buffer. |
| STRSAFE_NO_TRUNCATION |
Se questo flag è impostato e la funzione restituisce STATUS_BUFFER_OVERFLOW:
|
| STRSAFE_ZERO_LENGTH_ON_FAILURE | Se questo flag è impostato e la funzione restituisce STATUS_BUFFER_OVERFLOW, la lunghezza della stringa di destinazione viene impostata su zero byte. |
Valore restituito
RtlUnicodeStringCopyStringEx restituisce uno dei valori NTSTATUS seguenti.
| Codice restituito | Descrizione |
|---|---|
| STATUS_SUCCESS | Questo esito positivo stato indica che i dati di origine erano presenti e le stringhe sono state concatenate senza troncamento. |
| STATUS_BUFFER_OVERFLOW | Questo avviso stato indica che l'operazione di copia non è stata completata a causa di spazio insufficiente nel buffer di destinazione. Se STRSAFE_NO_TRUNCATION è impostato in dwFlags, il buffer di destinazione non viene modificato. Se il flag non è impostato, il buffer di destinazione contiene una versione troncata della stringa copiata. |
| STATUS_INVALID_PARAMETER | Questo errore stato indica che la funzione ha ricevuto un parametro di input non valido. Per altre informazioni, vedere l'elenco seguente. |
RtlUnicodeStringCopyStringEx restituisce il valore STATUS_INVALID_PARAMETER quando si verifica una delle condizioni seguenti:
- Il contenuto di una struttura di UNICODE_STRING non è valido.
- Un flag non valido viene specificato in dwFlags.
- Il buffer di destinazione è già pieno.
- Un puntatore al buffer è NULL e il flag di STRSAFE_IGNORE_NULLS non è specificato in dwFlags.
- Il puntatore del buffer di destinazione è NULL, ma la dimensione del buffer non è zero.
- Il puntatore del buffer di destinazione è NULLo la sua lunghezza è zero, ma è presente una stringa di origine di lunghezza diversa da zero.
Per informazioni su come testare i valori NTSTATUS, vedere Uso di valori NTSTATUS.
Osservazioni
La funzione RtlUnicodeStringCopyStringEx usa le dimensioni del buffer di destinazione per garantire che l'operazione di concatenazione non scriva oltre la fine del buffer. Per impostazione predefinita, la funzione non terminare la stringa risultante con un valore di carattere Null, ovvero con zero. Come opzione, il chiamante può usare il flag STRSAFE_FILL_BEHIND e un valore di byte di riempimento pari a zero per terminare null una stringa risultante che non occupa l'intero buffer di destinazione.
RtlUnicodeStringCopyStringEx aggiunge alla funzionalità della funzione RtlUnicodeStringCopyString restituendo una struttura UNICODE_STRING che identifica la fine della stringa di destinazione e il numero di byte rimasti inutilizzati in tale stringa. È possibile passare flag a RtlUnicodeStringCopyStringEx per un controllo aggiuntivo.
Se le stringhe di origine e di destinazione si sovrappongono, il comportamento della funzione non è definito.
I puntatori pszSrc e DestinationString non possono essere NULL a meno che il flag STRSAFE_IGNORE_NULLS non sia impostato in dwFlags. Se STRSAFE_IGNORE_NULLS è impostato, uno o entrambi questi puntatori possono essere NULL. Se il puntatore DestinationString è null, il puntatore pszSrc deve essere NULL o puntare a una stringa vuota.
Per altre informazioni sulle funzioni della stringa sicura, vedere Uso di funzioni stringa sicure.
Fabbisogno
| Requisito | Valore |
|---|---|
| client minimo supportato | Disponibile a partire da Windows XP con Service Pack 1 (SP1). |
| piattaforma di destinazione | Desktop |
| intestazione | ntstrsafe.h (include Ntstrsafe.h) |
| libreria | Ntstrsafe.lib |
| IRQL | Qualsiasi se le stringhe modificate sono sempre residenti in memoria, altrimenti PASSIVE_LEVEL |