Função OleUIPromptUserA (oledlg.h)

  • Artigo

Exibe uma caixa de diálogo com o modelo especificado e retorna a resposta (identificador de botão) do usuário. Essa função é usada para exibir mensagens de aviso OLE, por exemplo, Classe Não Registrada.

Sintaxe

int OleUIPromptUserA(
  [in] int  nTemplate,
  [in] HWND hwndParent,
       ...  
);

Parâmetros

[in] nTemplate

O número do recurso da caixa de diálogo a ser exibida. Consulte Observações.

[in] hwndParent

O identificador para a janela pai da caixa de diálogo.

...

Opcional. O título da caixa de diálogo seguido por uma lista de argumentos para a cadeia de caracteres de formato no controle estático (IDC_PU_TEXT) da caixa de diálogo. O chamador deve ter certeza de passar o número correto e os tipos de argumentos.

Retornar valor

Definições padrão de êxito/erro

Código de retorno Descrição
OLEUI_FALSE
 Falha desconhecida (não utilizado).
OLEUI_OK
 O usuário pressionou o botão OK .
OLEUI_SUCCESS
 Nenhum erro, o mesmo que OLEUI_OK.
OLEUI_CANCEL
 O usuário pressionou o botão Cancelar .
 

Erros de validação de campo padrão

Código de retorno Descrição
OLEUI_ERR_STANDARDMIN
 Erros comuns a todas as caixas de diálogo estão no intervalo OLEUI_ERR_STANDARDMIN a OLEUI_ERR_STANDARDMAX. Esse valor permite que o aplicativo teste mensagens padrão para exibir mensagens de erro para o usuário.
OLEUI_ERR_STRUCTURENULL
 O ponteiro para uma estrutura OLEUIXXX passada para a função era NULL.
OLEUI_ERR_STRUCTUREINVALID
 Permissões insuficientes para acesso de leitura ou gravação a uma estrutura OLEUIXXX.
OLEUI_ERR_CBSTRUCTINCORRECT
 O valor de cbstruct está incorreto.
OLEUI_ERR_HWNDOWNERINVALID
 O valor hWndOwner é inválido.
OLEUI_ERR_LPSZCAPTIONINVALID
 O valor lpszCaption é inválido.
OLEUI_ERR_LPFNHOOKINVALID
 O valor lpfnHook é inválido.
OLEUI_ERR_HINSTANCEINVALID
 O valor hInstance é inválido.
OLEUI_ERR_LPSZTEMPLATEINVALID
 O valor lpszTemplate é inválido.
OLEUI_ERR_HRESOURCEINVALID
 O valor hResource é inválido.
 

Erros de inicialização

Código de retorno Descrição
OLEUI_ERR_FINDTEMPLATEFAILURE
 Não é possível localizar o modelo da caixa de diálogo.
OLEUI_ERR_LOADTEMPLATEFAILURE
 Não é possível carregar o modelo da caixa de diálogo.
OLEUI_ERR_DIALOGFAILURE
 Falha na inicialização da caixa de diálogo.
OLEUI_ERR_LOCALMEMALLOC
 Uma chamada para LocalAlloc ou o alocador IMalloc padrão falhou.
OLEUI_ERR_GLOBALMEMALLOC
 Uma chamada para GlobalAlloc ou o alocador IMalloc padrão falhou.
OLEUI_ERR_LOADSTRING
 Não é possível chamar LoadString para recursos localizados da biblioteca.
OLEUI_ERR_OLEMEMALLOC
 Falha em uma chamada para o alocador IMalloc padrão.
 

Erros específicos da função

Código de retorno Descrição
OLEUI_ERR_STANDARDMAX
 Erros comuns a todas as caixas de diálogo estão no intervalo OLEUI_ERR_STANDARDMIN a OLEUI_ERR_STANDARDMAX. Esse valor permite que o aplicativo teste mensagens padrão para exibir mensagens de erro para o usuário.

Comentários

Os modelos de caixa de diálogo a seguir são definidos em Diretrizes de Interface do Windows – Um Guia para a Criação de Software. O parâmetro nTemplate deve ser um recurso definido no momento, no entanto, modelos adicionais podem ser adicionados a prompt.dlg.

IDD_LINKSOURCEUNAVAILABLE 
IDD_CANNOTUPDATELINK 
IDD_SERVERNOTREG 
IDD_CANNOTRESPONDVERB 
IDD_SERVERNOTFOUND

Observação

O cabeçalho oledlg.h define OleUIPromptUser como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante do pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho oledlg.h
Biblioteca OleDlg.lib
DLL OleDlg.dll