Função GetSaveFileNameA (commdlg.h)

Artigo
08/22/2023

[A partir do Windows Vista, as caixas de diálogo comuns Abrir e Salvar como foram substituídas pela caixa de diálogo Item Comum. Recomendamos que você use a API de Caixa de Diálogo de Item Comum em vez dessas caixas de diálogo da Biblioteca de Caixas de Diálogo Comuns.]

Cria uma caixa de diálogo Salvar que permite que o usuário especifique a unidade, o diretório e o nome de um arquivo a ser salvo.

Sintaxe

BOOL GetSaveFileNameA(
  [in, out] LPOPENFILENAMEA unnamedParam1
);

Parâmetros

[in, out] unnamedParam1

Tipo: LPOPENFILENAME

Um ponteiro para uma estrutura OPENFILENAME que contém informações usadas para inicializar a caixa de diálogo. Quando GetSaveFileName retorna, essa estrutura contém informações sobre a seleção de arquivo do usuário.

Retornar valor

Tipo: BOOL

Se o usuário especificar um nome de arquivo e clicar no botão OK e a função for bem-sucedida, o valor retornado será diferente de zero. O buffer apontado pelo membro lpstrFile da estrutura OPENFILENAME contém o caminho completo e o nome do arquivo especificados pelo usuário.

Se o usuário cancelar ou fechar a caixa de diálogo Salvar ou ocorrer um erro como o buffer de nome de arquivo muito pequeno, o valor retornado será zero. Para obter informações de erro estendidas, chame a função CommDlgExtendedError , que pode retornar um dos seguintes valores:

Comentários

A caixa de diálogo Salvar no estilo Explorer que fornece recursos de interface do usuário semelhantes ao windows Explorer. Você pode fornecer um procedimento de gancho OFNHookProc para uma caixa de diálogo Salvar no estilo Explorer. Para habilitar o procedimento de gancho, defina os sinalizadores OFN_EXPLORER e OFN_ENABLEHOOK no membro Flags da estrutura OPENFILENAME e especifique o endereço do procedimento de gancho no membro lpfnHook .

O Windows continua a dar suporte a caixas de diálogo Salvar de estilo antigo para aplicativos que desejam manter uma interface do usuário consistente com a interface do usuário de estilo antigo. Para exibir a caixa de diálogo Salvar de estilo antigo, habilite um procedimento de gancho OFNHookProcOldStyle e verifique se o sinalizador OFN_EXPLORER não está definido.

Exemplos

Para obter um exemplo, consulte Criando um metarquivo avançado.

Observação

O cabeçalho commdlg.h define GetSaveFileName como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de 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	commdlg.h (inclua Windows.h)
Biblioteca	Comdlg32.lib
DLL	Comdlg32.dll
Conjunto de APIs	ext-ms-win-shell-comdlg32-l1-1-1 (introduzido no Windows 10, versão 10.0.14393)