Función StringCbCopyNExA (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.

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

StringCbCopyNEx es un reemplazo de las siguientes funciones:

• strncpy, wcsncpy, _tcsncpy

Sintaxis

STRSAFEAPI StringCbCopyNExA(
  [out]           STRSAFE_LPSTR  pszDest,
  [in]            size_t         cbDest,
  [in]            STRSAFE_PCNZCH pszSrc,
  [in]            size_t         cbToCopy,
  [out, optional] STRSAFE_LPSTR  *ppszDestEnd,
  [out, optional] size_t         *pcbRemaining,
  [in]            DWORD          dwFlags
);

Parámetros

[out] pszDest

Tipo: LPTSTR

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

[in] cbDest

Tipo: size_t

Tamaño de pszDest, en bytes. Este valor debe ser lo suficientemente grande como para contener los bytes copiados (la longitud de pszSrc o el valor de cbSrc, lo que sea menor) así como para tener en cuenta 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

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.

[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] pcbRemaining

Tipo: size_t*

Número de bytes no usados en pszDest, incluidos los usados para el carácter nulo de terminación. Si pcbRemaining es NULL, el recuento no se mantiene ni se devuelve.

[in] dwFlags

Tipo: DWORD

Uno o varios de los valores siguientes.

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.

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

Comentarios

StringCbCopyNEx 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. StringCbCopyNEx 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 cbSrc es mayor que el número de bytes en pszSrc, StringCbCopyNEx ,a diferencia de strncpy, no continúa rellenando pszDest con caracteres NULL hasta que se hayan copiado los bytes cbSrc .

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 .

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

Requisitos

Consulte también

Referencia

StringCbCopyN

StringCchCopyNEx