Funzione RtlStringCbCatExA (ntstrsafe.h)

  • Articolo

Le funzioni RtlStringCbCatExW e RtlStringCbCatExA concatenano due stringhe con conteggio byte.

Sintassi

NTSTRSAFEDDI RtlStringCbCatExA(
  [in, out, optional] NTSTRSAFE_PSTR  pszDest,
  [in]                size_t          cbDest,
  [in, optional]      NTSTRSAFE_PCSTR pszSrc,
  [out, optional]     NTSTRSAFE_PSTR  *ppszDestEnd,
  [out, optional]     size_t          *pcbRemaining,
  [in]                DWORD           dwFlags
);

Parametri

[in, out, optional] pszDest

Puntatore a un buffer che, in input, contiene una stringa con terminazione null a cui verrà concatenata pszSrc . Nell'output si tratta del buffer di destinazione che contiene l'intera stringa risultante. La stringa in pszSrc viene aggiunta alla fine della stringa in pszDest e terminata con un carattere Null. Il puntatore pszDest può essere NULL, ma solo se STRSAFE_IGNORE_NULLS è impostato in dwFlags.

[in] cbDest

Dimensioni del buffer di destinazione, in byte. Il buffer deve essere abbastanza grande per includere entrambe le stringhe e il carattere null terminante.

Per le stringhe Unicode, il numero massimo di byte è NTSTRSAFE_MAX_CCH * sizeof(WCHAR)

Per le stringhe ANSI, il numero massimo di byte è NTSTRSAFE_MAX_CCH * sizeof(char)

[in, optional] pszSrc

Puntatore a una stringa con terminazione null. Questa stringa verrà concatenata alla fine della stringa contenuta nel buffer in pszDest. Il puntatore pszSrc può essere NULL, ma solo se STRSAFE_IGNORE_NULLS è impostato in dwFlags.

[out, optional] ppszDestEnd

Se il chiamante fornisce un puntatore di indirizzi non NULL , dopo il completamento dell'operazione di concatenazione, la funzione carica tale indirizzo con un puntatore al terminatore null risultante del buffer di destinazione.

[out, optional] pcbRemaining

Se il chiamante fornisce un puntatore di indirizzi non NULL , la funzione carica l'indirizzo con il numero di byte inutilizzati presenti nel buffer a cui fa riferimento pszDest, inclusi i byte usati per il carattere null terminante.

[in] dwFlags

Uno o più flag e, facoltativamente, un byte di riempimento. I flag sono definiti come segue:

Valore Significato
STRSAFE_FILL_BEHIND_NULL Se questo flag è impostato e la funzione ha esito positivo, viene usato il byte basso di dwFlags per riempire la parte del buffer di destinazione che segue il carattere Null di terminazione.
STRSAFE_IGNORE_NULLS Se questo flag è impostato, pszDest o pszSrc o entrambi possono essere NULL. I puntatori pszSrc NULL vengono trattati come stringhe vuote (TEXT("")), che possono essere copiate. I puntatori pszDest NULL non possono ricevere stringhe non dispendiose.
STRSAFE_FILL_ON_FAILURE Se questo flag è impostato e la funzione ha esito negativo, il byte basso di dwFlags viene usato per riempire l'intero buffer di destinazione e il buffer viene terminato null. Questa operazione sovrascrive qualsiasi contenuto del buffer preesistente.
STRSAFE_NULL_ON_FAILURE Se questo flag è impostato e la funzione ha esito negativo, il buffer di destinazione è impostato su una stringa vuota (TEXT(""). Questa operazione sovrascrive qualsiasi contenuto del buffer preesistente.
STRSAFE_NO_TRUNCATION

Se questo flag è impostato e la funzione restituisce STATUS_BUFFER_OVERFLOW:

  • Se STRSAFE_FILL_ON_FAILURE viene specificato anche, STRSAFE_NO_TRUNCATION riempie di conseguenza il buffer di destinazione.
  • In caso contrario, il buffer di destinazione verrà modificato.

Valore restituito

La funzione restituisce uno dei valori NTSTATUS elencati nella tabella seguente. Per informazioni su come testare i valori NTSTATUS, vedere Uso di valori NTSTATUS.

Codice restituito Descrizione
STATUS_SUCCESS Questo stato di esito positivo indica che i dati di origine erano presenti, le stringhe sono state completamente concatenate senza troncamento e il buffer di destinazione risultante viene terminato con null.
STATUS_BUFFER_OVERFLOW Questo stato di avviso indica che l'operazione di copia non è stata completata a causa di spazio insufficiente nel buffer di destinazione. Se STRSAFE_NO_TRUNCATION è impostato, vedere il parametro dwFlags per altre informazioni.
STATUS_INVALID_PARAMETER

Questo stato di errore indica che la funzione ha ricevuto un parametro di input non valido. Per altre informazioni, vedere il paragrafo seguente.

La funzione restituisce la STATUS_INVALID_PARAMETER quando:

  • È stato specificato un flag non valido.
  • Il valore in cbDest è maggiore della dimensione massima del buffer.
  • Il buffer di destinazione era già pieno.
  • Un puntatore NULL è stato presente senza il flag di STRSAFE_IGNORE_NULLS .
  • Il puntatore del buffer di destinazione era NULL, ma la dimensione del buffer non era zero.
  • Il puntatore del buffer di destinazione era NULL o la lunghezza era zero, ma era presente una stringa di origine di lunghezza non zero.

Commenti

RtlStringCbCatExW e RtlStringCbCatExA devono essere usati anziché le funzioni seguenti:

  • strcat
  • wcscat

Poiché RtlStringCbCatExW e RtlStringCbCatExAricevono le dimensioni del buffer di destinazione come input, non scriveranno oltre la fine del buffer.

RtlStringCbCatEx aggiunge alla funzionalità di RtlStringCbCat restituendo un puntatore alla fine della stringa di destinazione, nonché il numero di byte lasciati inutilizzati in tale stringa. I flag possono anche essere passati alla funzione per un controllo aggiuntivo.

Usare RtlStringCbCatExW per gestire stringhe Unicode e RtlStringCbCatExA per gestire le stringhe ANSI. Il modulo da usare è determinato dai dati, come illustrato nella tabella seguente.

Dati di tipo stringa Valore letterale stringa Funzione
WCHAR L"string" RtlStringCbCatExW
char "stringa" RtlStringCbCatExA

Se pszSrc e pszDest puntano a stringhe sovrapposte, il comportamento della funzione non è definito.

Né pszSrc né pszDest possono essere NULL a meno che il flag di STRSAFE_IGNORE_NULLS sia impostato, nel qual caso o entrambi possono essere NULL. Se pszDest è NULL, pszSrc deve essere NULL o puntare a una stringa vuota.

Per altre informazioni sulle funzioni stringa sicure, vedere Uso di funzioni stringa sicure.

Requisiti

Requisito Valore
Client minimo supportato Disponibile in Windows XP con Service Pack 1 (SP1) e versioni successive di Windows.
Piattaforma di destinazione Desktop
Intestazione ntstrsafe.h (include Ntstrsafe.h)
Libreria Ntstrsafe.lib
IRQL PASSIVE_LEVEL

Vedi anche