Función StringCbCopyNA (strsafe.h)
Copia el número especificado de bytes 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 más allá del final de este búfer.
StringCbCopyN es un reemplazo de las funciones siguientes:
Sintaxis
STRSAFEAPI StringCbCopyNA(
[out] STRSAFE_LPSTR pszDest,
[in] size_t cbDest,
[in] STRSAFE_PCNZCH pszSrc,
[in] size_t cbToCopy
);
Parámetros
[out] pszDest
Tipo: LPTSTR de
El búfer de destino, que recibe los caracteres copiados.
[in] cbDest
Tipo: size_t
Tamaño de pszDest, en bytes. Este valor debe ser lo suficientemente grande como para contener los bytes copiados (el tamaño de pszSrc o el valor de cbSrc, lo que sea menor) y también tener en cuenta el carácter nulo de terminación. El número máximo de caracteres permitido es STRSAFE_MAX_CCH * sizeof(TCHAR).
[in] pszSrc
Tipo: LPCTSTR de
Cadena de origen. Esta cadena debe terminar en null.
[in] cbToCopy
Tipo: size_t
Número máximo de bytes que se van a copiar de pszSrc a pszDest.
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 |
|---|---|
|
Los datos de origen se encontraban presentes, los datos se copiaron de pszSrc sin truncamiento y el búfer de destino resultante está terminado en null. |
|
El valor de cbDest es mayor que STRSAFE_MAX_CCH * sizeof(TCHAR)o el búfer de destino ya está lleno.
|
|
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 de HRESULT, a diferencia de las funciones que reemplaza.
Observaciones
StringCbCopyN 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. StringCbCopyN siempre finaliza 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 un reemplazo de strncpy, hay diferencias en el comportamiento. Si cbSrc es mayor que el número de bytes de pszSrc, StringCbCopyN,a diferencia de strncpy, no sigue rellenando pszDest con caracteres NULL hasta que se hayan copiado cbSrc bytes.
El comportamiento no está definido si las cadenas a las que apunta pszSrc y pszDest superposición.
Ni pszSrc ni pszDest deben ser NULL. Consulte stringCbCopyNEx si necesita el control de valores de puntero de cadena NULL.
StringCbCopyN 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.
| Tipo de datos de cadena | Literal de cadena | Función |
|---|---|---|
| char | "string" | StringCbCopyNA |
| TCHAR | TEXT("string") | StringCbCopyN |
| WCHAR | L"string" | stringCbCopyNW |
Nota
El encabezado strsafe.h define StringCbCopyN 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 Conventions for Function Prototypes.
Requisitos
| Requisito | Valor |
|---|---|
| cliente mínimo admitido | Windows XP con SP2 [aplicaciones de escritorio | Aplicaciones para UWP] |
| servidor mínimo admitido | Windows Server 2003 con SP1 [aplicaciones de escritorio | Aplicaciones para UWP] |
| de la plataforma de destino de |
Windows |
| encabezado de |
strsafe.h |
Consulte también
de referencia de
stringCchCopyN de