Função OleUIPromptUserA (oledlg.h)

Artigo
11/20/2024

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 Comentários.

[in] hwndParent

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

...

Opcional. O título da caixa de diálogo seguida 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 e os tipos corretos de argumentos.

Valor de retorno

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 foi NULL.
OLEUI_ERR_STRUCTUREINVALID	Permissões insuficientes para acesso de leitura ou gravação a uma estrutura OLEUIXXX.
OLEUI_ERR_CBSTRUCTINCORRECT	O valor de 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 de hInstance é inválido.
OLEUI_ERR_LPSZTEMPLATEINVALID	O valor lpszTemplate é inválido.
OLEUI_ERR_HRESOURCEINVALID	O hResource valor é 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	Falha ao LocalAlloc ou ao alocador de IMalloc de padrão.
OLEUI_ERR_GLOBALMEMALLOC	Falha ao GlobalAlloc ou ao alocador de IMalloc de padrão.
OLEUI_ERR_LOADSTRING	Não é possível chamar LoadString para recursos localizados da biblioteca.
OLEUI_ERR_OLEMEMALLOC	Falha ao chamar o alocador de IMalloc de 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.

Observações

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

IDD_LINKSOURCEUNAVAILABLE 
IDD_CANNOTUPDATELINK 
IDD_SERVERNOTREG 
IDD_CANNOTRESPONDVERB 
IDD_SERVERNOTFOUND

Nota

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. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows 2000 Professional [somente aplicativos da área de trabalho]
servidor com suporte mínimo	Windows 2000 Server [somente aplicativos da área de trabalho]
da Plataforma de Destino	Windows
cabeçalho	oledlg.h
biblioteca	OleDlg.lib
de DLL	OleDlg.dll

Compartilhar via