Función SetupCopyErrorA (setupapi.h)

Artículo
03/15/2023

[Esta función está disponible para su uso en los sistemas operativos indicados en la sección Requisitos. En versiones posteriores podría modificarse o no estar disponible. SetupAPI ya no debe usarse para instalar aplicaciones. En su lugar, use Windows Installer para desarrollar instaladores de aplicaciones. SetupAPI sigue usándose para instalar controladores de dispositivos.

La función SetupCopyError genera un cuadro de diálogo para notificar a un usuario un error de archivo de copia.

Sintaxis

WINSETUPAPI UINT SetupCopyErrorA(
  [in]      HWND   hwndParent,
  [in]      PCSTR  DialogTitle,
  [in]      PCSTR  DiskName,
  [in]      PCSTR  PathToSource,
  [in]      PCSTR  SourceFile,
  [in]      PCSTR  TargetPathFile,
  [out]     UINT   Win32ErrorCode,
  [in]      DWORD  Style,
  [in, out] PSTR   PathBuffer,
  [in]      DWORD  PathBufferSize,
  [in, out] PDWORD PathRequiredSize
);

Parámetros

[in] hwndParent

Identificador de la ventana primaria de este cuadro de diálogo.

[in] DialogTitle

Puntero opcional a una cadena terminada en null que especifica el título del cuadro de diálogo.

Este parámetro puede ser NULL. Si este parámetro es NULL, se usa el título predeterminado de "Copy Error" (localizado en el idioma del sistema).

[in] DiskName

Puntero opcional a una cadena terminada en null que especifica el nombre del disco que se va a insertar.

Este parámetro puede ser NULL. Si este parámetro es NULL, se usa el nombre predeterminado "(Unknown)" (localizado en el idioma del sistema).

[in] PathToSource

Puntero al componente de ruta de acceso del archivo de origen donde se produce un error en una operación, por ejemplo, F:\x86.

Use una cadena terminada en NULL.

[in] SourceFile

Puntero a una cadena terminada en null que especifica la parte de nombre de archivo del archivo donde se produce un error en una operación.

Use una cadena terminada en NULL. Este nombre de archivo se muestra si el usuario hace clic en los botones Detalles o Examinar . La función SetupCopyError busca el archivo que usa sus nombres de formulario comprimidos. Por lo tanto, puede pasar cmd.exe y no preocuparse de que el archivo existe realmente como cmd.ex_ en el medio de origen.

[in] TargetPathFile

Puntero opcional a una cadena terminada en null que especifica la ruta de acceso completa del archivo de destino para las operaciones de cambio de nombre y copia.

Use una cadena terminada en NULL. Este parámetro puede ser NULL. Si no se especifica TargetPathFile, se usa "(Unknown)" (localizado en el idioma del sistema).

[out] Win32ErrorCode

Si se produce un error, este miembro es el código de error del sistema.

Si no se produce un error, se NO_ERROR.

[in] Style

Marcas que controlan el formato y el comportamiento de un cuadro de diálogo.

Este parámetro puede ser una de las marcas siguientes.

IDF_NOBROWSE

No muestre la opción Examinar.

IDF_NOSKIP

No muestre la opción omitir archivo.

IDF_NODETAILS

No muestre la opción de detalles.

Si se establece esta marca, se pueden omitir los parámetros TargetPathFile y Win32ErrorCode .

IDF_NOCOMPRESSED

No compruebe si hay versiones comprimidas del archivo de origen.

IDF_OEMDISK

El origen de la operación es un disco que proporciona un fabricante de hardware.

IDF_NOBEEP

Impide que el cuadro de diálogo pita para llamar la atención del usuario cuando aparezca por primera vez.

IDF_NOFOREGROUND

Impide que el cuadro de diálogo se convierta en la ventana de primer plano.

IDF_WARNIFSKIP

Advierte al usuario que omitir un archivo puede afectar a la instalación.

[in, out] PathBuffer

Puntero opcional a una variable en la que esta función devuelve la ruta de acceso (no incluido el nombre de archivo) de la ubicación que especifica un usuario en el cuadro de diálogo. Debe usar una cadena terminada en NULL.

La cadena terminada en null no debe superar el tamaño del búfer de destino. Para evitar errores de búfer insuficientes, PathBuffer debe ser al menos MAX_PATH. Para obtener más información, vea la sección Comentarios.

[in] PathBufferSize

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

El tamaño del búfer debe tener al menos MAX_PATH caracteres, incluido el terminador null .

[in, out] PathRequiredSize

Puntero opcional a una variable en la que esta función devuelve el tamaño de búfer necesario, en caracteres, incluido el terminador null .

Valor devuelto

La función devuelve uno de los valores siguientes.

Para obtener información de error extendida, llame a GetLastError.

Comentarios

Si se llama a esta función con pathBuffer de NULL y pathBufferSize de 0 (cero), la función coloca el tamaño del búfer necesario para contener los datos especificados en la variable a la que apunta PathRequiredSize.

Si la función se realiza correctamente, el valor devuelto es NO_ERROR. De lo contrario, el valor devuelto es uno de los valores especificados.

Para evitar errores de búfer insuficientes, ReturnBuffer debe ser al menos MAX_PATH.

Nota

El encabezado setupapi.h define SetupCopyError 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 [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2003 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	setupapi.h
Library	Setupapi.lib
Archivo DLL	Setupapi.dll