Función SetupGetTargetPathW (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 utilizándose para instalar controladores de dispositivo.

La función SetupGetTargetPath determina el directorio de destino de una sección de lista de archivos. La sección de lista de archivos puede ser una sección Copiar archivos , una sección Eliminar archivos o una sección Cambiar nombre de archivos . Todos los archivos de la sección deben estar en un único directorio que aparezca en una sección DestinationDirs del archivo INF.

Sintaxis

WINSETUPAPI BOOL SetupGetTargetPathW(
  [in]      HINF        InfHandle,
  [in]      PINFCONTEXT InfContext,
  [in]      PCWSTR      Section,
  [in, out] PWSTR       ReturnBuffer,
  [in]      DWORD       ReturnBufferSize,
  [in, out] PDWORD      RequiredSize
);

Parámetros

[in] InfHandle

Identificador del archivo INF de carga que contiene una sección DestinationDirs .

[in] InfContext

Puntero opcional a un contexto INF que especifica una línea en una sección de lista de archivos cuyo directorio de destino se va a recuperar. Si InfContext es NULL, se usa el parámetro Section .

[in] Section

Parámetro opcional que especifica el nombre de una sección del archivo INF cuyo identificador es InfHandle. SetupGetTargetPath recupera el directorio de destino de esta sección. El parámetro Section se omite si se especifica InfContext . Si no se especifica InfContext ni Section , la función recupera la ruta de acceso de destino predeterminada del archivo INF. Debe usar una cadena terminada en null.

[in, out] ReturnBuffer

Puntero opcional al búfer para recibir la ruta de acceso de destino completa. Se garantiza que la ruta de acceso no termine con . Debe usar una cadena terminada en null. Puede llamar a la función una vez para obtener el tamaño de búfer necesario, asignar la memoria necesaria y, a continuación, llamar a la función una segunda vez para recuperar los datos. Con esta técnica, puede evitar errores debido a un tamaño de búfer insuficiente. Consulte la sección Comentarios. Este parámetro puede ser NULL.

[in] ReturnBufferSize

Tamaño del búfer al que apunta ReturnBuffer, en caracteres. Esto incluye el terminador null .

[in, out] RequiredSize

Puntero opcional a una variable que recibe el tamaño necesario para el búfer al que apunta ReturnBuffer, en caracteres. Esto incluye el terminador null . Si el tamaño real necesario es mayor que el valor especificado por ReturnBufferSize, se produce un error en la función y se devuelve una llamada a GetLastError ERROR_INSUFFICIENT_BUFFER.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es un valor distinto de cero.

Si la función no se realiza correctamente, el valor devuelto es cero. Para obtener información de error extendida, llame a GetLastError.

Comentarios

Si se llama a esta función con returnBuffer de NULL y returnBufferSize de cero, la función coloca el tamaño del búfer necesario para contener los datos especificados en la variable a la que apunta RequiredSize. Si la función se ejecuta correctamente, el valor devuelto es un valor distinto de cero. De lo contrario, el valor devuelto es cero y se puede obtener información de error extendida llamando a GetLastError.

Nota

El encabezado setupapi.h define SetupGetTargetPath 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 [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