Função RtlStringCbCopyNExA (ntstrsafe.h)

Artigo
07/16/2024

As funções rtlStringCbCopyNExW e RtlStringCbCopyNExA copiam uma cadeia de caracteres contada por bytes para um buffer, limitando o tamanho da cadeia de caracteres copiada.

Sintaxe

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

Parâmetros

[out, optional] pszDest

Um ponteiro para um buffer fornecido pelo chamador que recebe a cadeia de caracteres copiada. A cadeia de caracteres em pszSrc é copiada para o buffer em pszDest e terminada com um caractere nulo. O ponteiro pszDest pode ser NULL, mas somente se STRSAFE_IGNORE_NULLS estiver definido em dwFlags.

[in] cbDest

O tamanho, em bytes, do buffer de destino. O buffer deve ser grande o suficiente para a cadeia de caracteres e o caractere nulo de encerramento.

Para cadeias de caracteres Unicode, o número máximo de bytes é NTSTRSAFE_MAX_CCH * sizeof(WCHAR)

Para cadeias de caracteres ANSI, o número máximo de bytes é NTSTRSAFE_MAX_CCH * sizeof(char)

Se pszDest for NULL, cbDest deverá ser zero.

[in, optional] pszSrc

Um ponteiro para uma cadeia de caracteres fornecida pelo chamador e terminada em nulo. O ponteiro pszSrc pode ser NULL, mas somente se STRSAFE_IGNORE_NULLS estiver definido em dwFlags.

cbToCopy

O número máximo de bytes a serem copiados de *pszSrc* para *pszDest*.

[out, optional] ppszDestEnd

Se o chamador fornecer um ponteiro de endereço NULL não, depois que a operação de cópia for concluída, a função carregará esse endereço com um ponteiro para o terminador de cadeia de caracteres nulo resultante do buffer de destino.

[out, optional] pcbRemaining

Se o chamador fornecer um ponteiro de endereço NULL não, a função carregará o endereço com o número de bytes não utilizados que estão no buffer apontado por pszDest, incluindo os bytes usados para o caractere nulo de terminação.

[in] dwFlags

Um ou mais sinalizadores e, opcionalmente, um byte de preenchimento. Os sinalizadores são definidos da seguinte maneira:

Valor	Significado
STRSAFE_FILL_BEHIND_NULL	Se esse sinalizador for definido e a função for bem-sucedida, o byte baixo de dwFlags será usado para preencher a parte do buffer de destino que segue o caractere nulo de terminação.
STRSAFE_IGNORE_NULLS	Se esse sinalizador estiver definido, pszDest ou pszSrc ou ambos poderão ser NULL. pszSrc ponteiros são tratados como cadeias de caracteres vazias (TEXT(")), que podem ser copiadas. pszDest não podem receber cadeias de caracteres não íntegras.
STRSAFE_FILL_ON_FAILURE	Se esse sinalizador for definido e a função falhar, o byte baixo de dwFlags será usado para preencher todo o buffer de destino e o buffer será encerrado em nulo. Essa operação substitui qualquer conteúdo de buffer pré-existente.
STRSAFE_NULL_ON_FAILURE	Se esse sinalizador estiver definido e a função falhar, o buffer de destino será definido como uma cadeia de caracteres vazia (TEXT("")). Essa operação substitui qualquer conteúdo de buffer pré-existente.
STRSAFE_NO_TRUNCATION	Se esse sinalizador estiver definido e a função retornar STATUS_BUFFER_OVERFLOW: Se STRSAFE_FILL_ON_FAILURE também for especificado, STRSAFE_NO_TRUNCATION preencherá o buffer de destino adequadamente. Caso contrário, o conteúdo do buffer de destino será definido como uma cadeia de caracteres vazia, mesmo que STRSAFE_NULL_ON_FAILURE não esteja definida. STRSAFE_FILL_BEHIND_NULL é ignorado.

Valor de retorno

A função retorna um dos valores NTSTATUS listados na tabela a seguir. Para obter informações sobre como testar valores NTSTATUS, consulte Usando valores NTSTATUS.

Código de retorno	Descrição
STATUS_SUCCESS	Esse êxito status significa que os dados de origem estavam presentes, a cadeia de caracteres foi copiada sem truncamento e o buffer de destino resultante foi encerrado em nulo.
STATUS_BUFFER_OVERFLOW	Esse aviso status significa que a operação de cópia não foi concluída devido ao espaço insuficiente no buffer de destino. Se STRSAFE_NO_TRUNCATION estiver definido, consulte o parâmetro dwFlags para obter mais informações.
STATUS_INVALID_PARAMETER	Esse erro status significa que a função recebeu um parâmetro de entrada inválido. Para obter mais informações, consulte o parágrafo a seguir. A função retorna o valor STATUS_INVALID_PARAMETER quando: Um sinalizador inválido foi especificado. O valor em cbDest é maior que o tamanho máximo do buffer. O buffer de destino já estava cheio. Um ponteiro NULL estava presente sem o sinalizador STRSAFE_IGNORE_NULLS. O ponteiro do buffer de destino foi NULL, mas o tamanho do buffer não era zero. O ponteiro do buffer de destino foi NULL ou seu comprimento era zero, mas uma cadeia de caracteres de origem de comprimento diferente de zero estava presente.

Código de retorno

Descrição

STATUS_SUCCESS

Esse êxito status significa que os dados de origem estavam presentes, a cadeia de caracteres foi copiada sem truncamento e o buffer de destino resultante foi encerrado em nulo.

STATUS_BUFFER_OVERFLOW

Esse aviso status significa que a operação de cópia não foi concluída devido ao espaço insuficiente no buffer de destino. Se STRSAFE_NO_TRUNCATION estiver definido, consulte o parâmetro dwFlags para obter mais informações.

STATUS_INVALID_PARAMETER

Esse erro status significa que a função recebeu um parâmetro de entrada inválido. Para obter mais informações, consulte o parágrafo a seguir.

A função retorna o valor STATUS_INVALID_PARAMETER quando:

Um sinalizador inválido foi especificado.
O valor em cbDest é maior que o tamanho máximo do buffer.
O buffer de destino já estava cheio.
Um ponteiro NULL estava presente sem o sinalizador STRSAFE_IGNORE_NULLS.
O ponteiro do buffer de destino foi NULL, mas o tamanho do buffer não era zero.
O ponteiro do buffer de destino foi NULL ou seu comprimento era zero, mas uma cadeia de caracteres de origem de comprimento diferente de zero estava presente.

Observações

rtlStringCbCopyNExW e rtlStringCbCopyNExA devem ser usados em vez de strncpy . No entanto, essas funções diferem no comportamento. Se cbSrc for maior que o número de bytes em pszSrc, as funções RtlStringCbCopyNEx, ao contrário de strncpy, não preencha pszDest com caracteres nulos até que cbSrc bytes tenham sido copiados.

O tamanho, em bytes, do buffer de destino é fornecido para rtlStringCbCopyNExW e RtlStringCbCopyNExA para garantir que eles não escrevam após o final desse buffer.

RtlStringCbCopyNEx adiciona à funcionalidade de rtlStringCbCopyN retornando um ponteiro para o final da cadeia de caracteres de destino, bem como o número de bytes deixados não utilizados nessa cadeia de caracteres. Sinalizadores também podem ser passados para a função para controle adicional.

Use rtlStringCbCopyNExW para lidar com cadeias de caracteres Unicode e rtlStringCbCopyNExA para lidar com cadeias de caracteres ANSI. O formulário usado depende de seus dados, conforme mostrado na tabela a seguir.

Tipo de dados de cadeia de caracteres	Literal de cadeia de caracteres	Função
WCHAR	L"string"	rtlStringCbCopyNExW
char	"string"	rtlStringCbCopyNExA

Se pszSrc e pszDest apontar para cadeias de caracteres sobrepostas, o comportamento da função será indefinido.

Nem pszSrc nem pszDest podem ser NULL, a menos que o sinalizador de STRSAFE_IGNORE_NULLS esteja definido; nesse caso, ambos podem ser NULL. Se pszDest for NULL, pszSrc deverá ser NULL ou apontar para uma cadeia de caracteres vazia.

Para obter mais informações sobre as funções de cadeia de caracteres seguras, consulte Usando funções de cadeia de caracteres seguras.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Disponível no Windows XP com Service Pack 1 (SP1) e versões posteriores do Windows.
da Plataforma de Destino	Área de trabalho
cabeçalho	ntstrsafe.h (inclua Ntstrsafe.h)
biblioteca	Ntstrsafe.lib
IRQL	Se as cadeias de caracteres que estão sendo manipuladas estiverem sempre residentes na memória, caso contrário, PASSIVE_LEVEL

Consulte também

rtlStringCbCopyN
rtlStringCchCopyNEx

Compartilhar via