Función StringCchCopyExA (strsafe.h)
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 después del final del búfer.
StringCchCopyEx agrega a la funcionalidad de StringCchCopy 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 esta función para un control adicional.
StringCchCopyEx es un reemplazo de las siguientes funciones:
Sintaxis
STRSAFEAPI StringCchCopyExA(
[out] STRSAFE_LPSTR pszDest,
[in] size_t cchDest,
[in] STRSAFE_LPCSTR pszSrc,
[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 del búfer de destino, en caracteres. Este valor debe ser igual a la longitud de pszSrc más 1 para tener en cuenta la cadena de origen copiada y 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 terminar en null.
[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 |
|---|---|
|
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. |
|
Trate punteros de cadena NULL como cadenas vacías (TEXT("")). Esta marca es útil para simular funciones como lstrcpy. |
|
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. |
|
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. |
|
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
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 están presentes, totalmente copiados sin truncamiento, y el búfer de destino resultante termina en null. |
|
PszDest es NULL cuando hay datos de origen presentes para copiar o se pasó una marca no válida. |
|
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
En comparación con las funciones que reemplaza, StringCchCopyEx 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. StringCchCopyEx 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 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 .
StringCchCopyEx 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" | StringCchCopyExA |
| TCHAR | TEXT("string") | StringCchCopyEx |
| WCHAR | L"string" | StringCchCopyExW |
Nota
El encabezado strsafe.h define StringCchCopyEx 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