Função MsiSourceListEnumMediaDisksA (msi.h)

A função MsiSourceListEnumMediaDisks enumera a lista de discos registrados para a fonte de mídia para um patch ou produto.

Sintaxe

UINT MsiSourceListEnumMediaDisksA(
  [in]                LPCSTR            szProductCodeOrPatchCode,
  [in, optional]      LPCSTR            szUserSid,
  [in]                MSIINSTALLCONTEXT dwContext,
  [in]                DWORD             dwOptions,
  [in]                DWORD             dwIndex,
  [out, optional]     LPDWORD           pdwDiskId,
  [out, optional]     LPSTR             szVolumeLabel,
  [in, out, optional] LPDWORD           pcchVolumeLabel,
  [out, optional]     LPSTR             szDiskPrompt,
  [in, out, optional] LPDWORD           pcchDiskPrompt
);

Parâmetros

[in] szProductCodeOrPatchCode

O ProductCode ou o GUID de patch do produto ou patch. Use uma cadeia de caracteres terminada em nulo. Se a cadeia de caracteres tiver mais de 39 caracteres, a função falhará e retornará ERROR_INVALID_PARAMETER. Esse parâmetro não pode ser NULL.

[in, optional] szUserSid

Um SID de cadeia de caracteres que especifica a conta de usuário que contém o produto ou patch. O SID não é validado ou resolvido. Um SID incorreto pode retornar ERROR_UNKNOWN_PRODUCT ou ERROR_UNKNOWN_PATCH. Ao referenciar um contexto de computador, szUserSID deve ser NULL e dwContext deve ser MSIINSTALLCONTEXT_MACHINE.

[in] dwContext

Esse parâmetro especifica o contexto da instância do produto ou patch. Esse parâmetro pode conter um dos valores a seguir.

[in] dwOptions

O valor dwOptions que especifica o significado de szProductCodeOrPatchCode.

[in] dwIndex

O índice da origem a ser recuperada. Esse parâmetro deve ser 0 (zero) para a primeira chamada para a função MsiSourceListEnumMediaDisks e incrementado para chamadas subsequentes até que a função retorne ERROR_NO_MORE_ITEMS.

[out, optional] pdwDiskId

Na entrada para MsiSourceListEnumMediaDisks , esse parâmetro fornece um ponteiro para um DWORD receber a ID do disco que está sendo enumerado. Esse parâmetro é opcional.

[out, optional] szVolumeLabel

Um buffer de saída que recebe o rótulo de volume do disco que está sendo enumerado. Esse buffer deve ser grande o suficiente para conter as informações. Se o buffer for muito pequeno, a função retornará ERROR_MORE_DATA e definirá *pcchVolumeLabel como o número de TCHAR no valor, sem incluir o caractere NULL de terminação.

Se szVolumeLabel e pcchVolumeLabel estiverem definidos como NULL, a função retornará ERROR_SUCCESS se o valor existir, sem recuperar o valor.

[in, out, optional] pcchVolumeLabel

Um ponteiro para uma variável que especifica o número de TCHAR no buffer szVolumeLabel . Quando a função retorna, esse parâmetro é o número de TCHAR no valor recebido, não incluindo o caractere nulo de terminação.

Esse parâmetro só poderá ser definido como NULL se szVolumeLabel também for NULL, caso contrário, a função retornará ERROR_INVALID_PARAMETER.

[out, optional] szDiskPrompt

Um buffer de saída que recebe o prompt de disco do disco que está sendo enumerado. Esse buffer deve ser grande o suficiente para conter as informações. Se o buffer for muito pequeno, a função retornará ERROR_MORE_DATA e definirá *pcchDiskPrompt como o número de TCHAR no valor, sem incluir o caractere NULL de terminação.

Se o szDiskPrompt estiver definido como NULL e pcchDiskPrompt estiver definido como um ponteiro válido, a função retornará ERROR_SUCCESS e definirá *pcchDiskPrompt para o número de TCHAR no valor, sem incluir o caractere NULL de terminação. Em seguida, a função pode ser chamada novamente para recuperar o valor, com o buffer szDiskPrompt grande o suficiente para conter *pcchDiskPrompt + 1 caracteres.

Se szDiskPrompt e pcchDiskPrompt estiverem definidos como NULL, a função retornará ERROR_SUCCESS se o valor existir, sem recuperar o valor.

[in, out, optional] pcchDiskPrompt

Um ponteiro para uma variável que especifica o número de TCHAR no buffer szDiskPrompt . Quando a função retorna, esse parâmetro é definido como o tamanho do valor solicitado se a função copia ou não o valor para o buffer especificado. O tamanho é retornado como o número de TCHAR no valor solicitado, não incluindo o caractere nulo de terminação.

Esse parâmetro só poderá ser definido como NULL se szDiskPrompt também for NULL, caso contrário, a função retornará ERROR_INVALID_PARAMETER.

Retornar valor

A função MsiSourceListEnumMediaDisks retorna os valores a seguir.

Comentários

Ao fazer várias chamadas para MsiSourceListEnumMediaDisks para enumerar todas as fontes de uma única instância do produto, cada chamada deve ser feita do mesmo thread.

Um administrador pode enumerar instalações gerenciadas e não gerenciadas por usuário para si mesmo, instalações por computador e instalações gerenciadas por usuário para qualquer usuário. Um administrador não pode enumerar instalações não gerenciadas por usuário para outros usuários. Os não administradores só podem enumerar suas próprias instalações não gerenciadas e gerenciadas por usuário e instalações por computador.

Requisitos

Confira também

Contexto de instalação

Sem suporte no Windows Installer 2.0 e nas versões anteriores

ProductCode