Función PathCchAddExtension (pathcch.h)

  • Artículo

Agrega una extensión de nombre de archivo a una cadena de ruta de acceso.

Esta función difiere de PathAddExtension en que acepta rutas de acceso con prefijos "\", "\?" y "\?\UNC".

Nota Esta función se debe usar en lugar de PathAddExtension para evitar la posibilidad de que se supere un búfer.

Sintaxis

WINPATHCCHAPI HRESULT PathCchAddExtension(
  [in, out] PWSTR  pszPath,
  [in]      size_t cchPath,
  [in]      PCWSTR pszExt
);

Parámetros

[in, out] pszPath

Puntero a la cadena de ruta de acceso. Cuando esta función vuelve correctamente, el búfer contiene la cadena con la extensión anexada. Este valor no debe ser NULL.

Nota Si la cadena original ya tiene una extensión de nombre de archivo presente, no se agregará ninguna nueva extensión y la cadena original no se modificará.

[in] cchPath

Tamaño del búfer al que apunta pszPath, en caracteres.

[in] pszExt

Puntero a la cadena de extensión de nombre de archivo. Esta cadena se puede proporcionar con o sin un punto anterior (".ext" o "ext").

Valor devuelto

Esta función devuelve un código HRESULT , incluido lo siguiente.

Código devuelto Descripción
S_OK
 La función se ha realizado correctamente. Tenga en cuenta que esto también incluye el caso de una extensión vacía, como un punto sin caracteres después. En ese caso, la cadena original se devuelve sin modificar.
E_INVALIDARG
 Este valor puede deberse a que varias cosas, como el parámetro pszPath se establece en NULL, cchPath se establece en 0 o un valor mayor que PATHCCH_MAX_CCH, o la cadena de extensión que contiene caracteres no válidos o no es una extensión válida.
S_FALSE
 La cadena original ya tiene una extensión.
PATHCCH_E_FILENAME_TOO_LONG
 El búfer es demasiado pequeño para contener la cadena devuelta.

Requisitos

Requisito Value
Cliente mínimo compatible Windows 8 [aplicaciones de escritorio | Aplicaciones para UWP]
Servidor mínimo compatible Windows Server 2012 [aplicaciones de escritorio | Aplicaciones para UWP]
Plataforma de destino Windows
Encabezado pathcch.h
Library Pathcch.lib