Función StringCchCopyNExA (strsafe.h)

  • Artículo

Copia el número especificado de caracteres de una cadena a otra. El tamaño del búfer de destino se proporciona a la función para asegurarse de que no escribe después del final de este búfer.

StringCchCopyNEx agrega a la funcionalidad de StringCchCopyN devolviendo un puntero al final de la cadena de destino, así como el número de caracteres que quedan sin usar en esa cadena. Las marcas también se pueden pasar a la función para un control adicional.

StringCchCopyNEx es un reemplazo de las siguientes funciones:

Sintaxis

STRSAFEAPI StringCchCopyNExA(
  [out]           STRSAFE_LPSTR  pszDest,
  [in]            size_t         cchDest,
  [in]            STRSAFE_PCNZCH pszSrc,
  [in]            size_t         cchToCopy,
  [out, optional] STRSAFE_LPSTR  *ppszDestEnd,
  [out, optional] size_t         *pcchRemaining,
  [in]            DWORD          dwFlags
);

Parámetros

[out] pszDest

Tipo: LPTSTR

Búfer de destino, que recibe la cadena copiada.

[in] cchDest

Tipo: size_t

Tamaño de pszDest, en caracteres. Este valor debe ser lo suficientemente grande como para contener los caracteres copiados (la longitud de pszSrc o el valor de cchSrc, lo que sea menor) más 1 para tener en cuenta el carácter nulo de terminación. El número máximo de caracteres permitido es STRSAFE_MAX_CCH.

[in] pszSrc

Tipo: LPCTSTR

Cadena de origen. Esta cadena debe ser legible hasta caracteres cchSrc o un terminador null, lo que ocurra primero.

[in] cchToCopy

Tipo: size_t

Número máximo de caracteres que se van a copiar de pszSrc a pszDest.

[out, optional] ppszDestEnd

Tipo: LPTSTR*

Dirección de un puntero al final de pszDest. Si ppszDestEnd no es NULL y los datos se copian en el búfer de destino, esto apunta al carácter nulo de terminación al final de la cadena.

[out, optional] pcchRemaining

Tipo: size_t*

Número de caracteres sin usar en pszDest, incluido el carácter nulo de terminación. Si pcchRemaining es NULL, el recuento no se mantiene ni se devuelve.

[in] dwFlags

Tipo: DWORD

Uno o varios de los valores siguientes.

Valor Significado
STRSAFE_FILL_BEHIND_NULL
0x00000200
 Si la función se ejecuta correctamente, se usa el byte bajo de dwFlags (0) para rellenar la parte no inicializada de pszDest después del carácter nulo de terminación.
STRSAFE_IGNORE_NULLS
0x00000100
 Trate punteros de cadena NULL como cadenas vacías (TEXT("")).
STRSAFE_FILL_ON_FAILURE
0x00000400
 Si se produce un error en la función, el byte bajo de dwFlags (0) se usa para rellenar todo el búfer pszDest y el búfer termina en null. En el caso de un error de STRSAFE_E_INSUFFICIENT_BUFFER , se sobrescribe cualquier cadena truncada devuelta.
STRSAFE_NULL_ON_FAILURE
0x00000800
 Si se produce un error en la función, pszDest se establece en una cadena vacía (TEXT("")). En el caso de un error de STRSAFE_E_INSUFFICIENT_BUFFER , se sobrescribe cualquier cadena truncada.
STRSAFE_NO_TRUNCATION
0x00001000
 Como en el caso de STRSAFE_NULL_ON_FAILURE, si se produce un error en la función, pszDest se establece en una cadena vacía (TEXT("")). En el caso de un error de STRSAFE_E_INSUFFICIENT_BUFFER , se sobrescribe cualquier cadena truncada.

Valor devuelto

Tipo: HRESULT

Esta función puede devolver uno de los siguientes valores. Se recomienda encarecidamente usar las macros SUCCEEDED y FAILED para probar el valor devuelto de esta función.

Código devuelto Descripción
S_OK
 Los datos de origen están presentes, totalmente copiados sin truncamiento, y el búfer de destino resultante termina en null.
STRSAFE_E_INVALID_PARAMETER
 PszDest o pszSrc es mayor que STRSAFE_MAX_CCH, pszDest es NULL cuando hay datos de origen presentes para copiar o se pasó una marca no válida.
STRSAFE_E_INSUFFICIENT_BUFFER
 Error en la operación de copia debido a un espacio de búfer insuficiente. Según el valor de dwFlags, el búfer de destino puede contener una versión truncada y terminada en null del resultado previsto. En situaciones en las que el truncamiento es aceptable, es posible que esto no se vea necesariamente como una condición de error.
 

Tenga en cuenta que esta función devuelve un valor HRESULT , a diferencia de las funciones que reemplaza.

Comentarios

StringCchCopyNEx proporciona procesamiento adicional para el control adecuado del búfer en el código. El control deficiente del búfer está implicado en muchos problemas de seguridad que implican saturaciones de búfer. StringCchCopyNEx siempre termina en null y nunca desborda un búfer de destino válido, incluso si el contenido de la cadena de origen cambia durante la operación.

Aunque esta rutina está pensada como reemplazo de strncpy, hay diferencias en el comportamiento. Si cchSrc es mayor que el número de caracteres de pszSrc, StringCchCopyNEx , a diferencia de strncpy, no continúa rellenando pszDest con caracteres NULL hasta que se hayan copiado caracteres cchSrc .

El comportamiento no está definido si las cadenas a las que apunta pszSrc y pszDest se superponen.

Ni pszSrc ni pszDest deben ser NULL a menos que se especifique la marca STRSAFE_IGNORE_NULLS , en cuyo caso ambos pueden ser NULL. Sin embargo, es posible que todavía se devuelva un error debido a un espacio insuficiente aunque se omitan los valores NULL .

StringCchCopyNEx se puede usar en su forma genérica o en sus formularios más específicos. El tipo de datos de la cadena determina la forma de esta función que debe usar, como se muestra en la tabla siguiente.

String (Tipo de datos) Literal de cadena Función
char "cadena" StringCchCopyNExA
TCHAR TEXT("string") StringCchCopyNEx
WCHAR L"string" StringCchCopyNExW
 

Nota

El encabezado strsafe.h define StringCchCopyNEx como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutro de codificación con código que no es neutral de codificación puede provocar discrepancias que dan lugar a errores de compilación o en tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos

Requisito Value
Cliente mínimo compatible Windows XP con SP2 [aplicaciones de escritorio | Aplicaciones para UWP]
Servidor mínimo compatible Windows Server 2003 con SP1 [aplicaciones de escritorio | Aplicaciones para UWP]
Plataforma de destino Windows
Encabezado strsafe.h

Consulte también

Referencia

StringCbCopyNEx

StringCchCopyN