Función StringCchCopyNA (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 StringCchCopyN no escribe más allá del final de este búfer.

StringCchCopyN es un reemplazo de las funciones siguientes:

Sintaxis

STRSAFEAPI StringCchCopyNA(
  [out] STRSAFE_LPSTR  pszDest,
  [in]  size_t         cchDest,
  [in]  STRSAFE_PCNZCH pszSrc,
  [in]  size_t         cchToCopy
);

Parámetros

[out] pszDest

Tipo: LPTSTR

El búfer de destino, que recibe los caracteres copiados.

[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.

Valor devuelto

Tipo: HRESULT

Esta función puede devolver uno de los valores siguientes. 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 estaban presentes, los caracteres se copiaron de pszSrc sin truncamiento y el búfer de destino resultante termina en null.
STRSAFE_E_INVALID_PARAMETER
 El valor de cchDest es mayor que STRSAFE_MAX_CCH o el búfer de destino ya está lleno.
STRSAFE_E_INSUFFICIENT_BUFFER
 Error en la operación de copia debido a un espacio de búfer insuficiente. El búfer de destino contiene una versión truncada 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

StringCchCopyN 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 del búfer. StringCchCopyN 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, StringCchCopyN ,a diferencia de strncpy, no continúa rellenando pszDest con caracteres NULL hasta que se hayan copiado los 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. Consulte StringCchCopyNEx si necesita el control de valores de puntero de cadena NULL.

StringCchCopyN 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" StringCchCopyNA
TCHAR TEXT("string") StringCchCopyN
WCHAR L"string" StringCchCopyNW
 

Nota

El encabezado strsafe.h define StringCchCopyN 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 neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos

   
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

StringCbCopyN

StringCchCopy

StringCchCopyNEx