Función StringCbCopyA (strsafe.h)

  • Artículo

Copia una cadena en 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.

StringCbCopy es un reemplazo de las funciones siguientes:

Sintaxis

STRSAFEAPI StringCbCopyA(
  [out] STRSAFE_LPSTR  pszDest,
  [in]  size_t         cbDest,
  [in]  STRSAFE_LPCSTR pszSrc
);

Parámetros

[out] pszDest

Tipo: LPTSTR

El búfer de destino, que recibe la cadena copiada.

[in] cbDest

Tipo: size_t

Tamaño del búfer de destino, en bytes. Este valor debe tener en cuenta la longitud de pszSrc más el carácter nulo de terminación. El número máximo de bytes permitido es STRSAFE_MAX_CCH * sizeof(TCHAR).

[in] pszSrc

Tipo: LPCTSTR

Puntero a un búfer que contiene la cadena de origen. Esta cadena de origen debe terminar en null.

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 se encontraban presentes, totalmente copiados sin truncamiento, y el búfer de destino resultante termina en null.
STRSAFE_E_INVALID_PARAMETER
 El valor de cbDest es menor sizeof(TCHAR) o mayor que el valor máximo permitido.
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

En comparación con las funciones que reemplaza, StringCbCopy proporciona un 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. StringCbCopy 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.

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 StringCbCopyEx si necesita el control de valores de puntero de cadena null.

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

String (Tipo de datos) Literal de cadena Función
char "cadena" StringCbCopyA
TCHAR TEXT("string") StringCbCopy
WCHAR L"string" StringCbCopyW
 

Nota

El encabezado strsafe.h define StringCbCopy 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

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

StringCbCopyEx

StringCchCopy