Función SetupGetSourceInfoA (setupapi.h)

Artículo
08/26/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 SetupGetSourceInfo recupera la ruta de acceso, el archivo de etiqueta o la descripción multimedia de un origen enumerado en un archivo INF.

Sintaxis

WINSETUPAPI BOOL SetupGetSourceInfoA(
  [in]      HINF   InfHandle,
  [in]      UINT   SourceId,
  [in]      UINT   InfoDesired,
  [in, out] PSTR   ReturnBuffer,
  [in]      DWORD  ReturnBufferSize,
  [in, out] PDWORD RequiredSize
);

Parámetros

[in] InfHandle

Identificador de un archivo INF abierto que contiene una sección SourceDisksNames . Si existen secciones específicas de la plataforma para el sistema del usuario (por ejemplo, SourceDisksNames.x86), se usará la sección específica de la plataforma.

[in] SourceId

Identificador de un medio de origen. Este valor se usa para buscar por clave en la sección SourceDisksNames .

[in] InfoDesired

Indica qué información se desea. Solo se puede especificar un valor por llamada de función y no se pueden combinar. Los siguientes tipos de información se pueden recuperar de una sección SourceDisksNames .

SRCINFO_PATH

Ruta de acceso especificada para el origen. Esta no es una ruta de acceso completa, pero la ruta de acceso relativa a la raíz de instalación.

SRCINFO_TAGFILE

El archivo de etiqueta que identifica el medio de origen, o si se usan los gabinetes, el nombre del archivo de gabinete.

SRCINFO_DESCRIPTION

Descripción del medio.

[in, out] ReturnBuffer

Puntero opcional a un búfer para recibir la información recuperada. Se garantiza que las devoluciones de ruta de acceso no terminan con . Debe usar una cadena terminada en null. La cadena terminada en null no debe superar el tamaño del búfer de destino. 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. Consulte la sección Comentarios. Con esta técnica, puede evitar errores debido a un tamaño de búfer insuficiente. 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 especificado por ReturnBuffer, en caracteres. Esto incluye el terminador null . Si se especifica ReturnBuffer y el tamaño real necesario es mayor que el valor especificado por ReturnBufferSize, la función produce un error y una llamada a GetLastError devuelve 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 SetupGetSourceInfo 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