IVsUIShell.SaveDocDataToFile(VSSAVEFLAGS, Object, String, String, Int32) Método
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Método auxiliar usado por editores que implementam a IVsPersistDocData interface.
public:
int SaveDocDataToFile(Microsoft::VisualStudio::Shell::Interop::VSSAVEFLAGS grfSave, System::Object ^ pPersistFile, System::String ^ pszUntitledPath, [Runtime::InteropServices::Out] System::String ^ % pbstrDocumentNew, [Runtime::InteropServices::Out] int % pfCanceled);
int SaveDocDataToFile(Microsoft::VisualStudio::Shell::Interop::VSSAVEFLAGS grfSave, winrt::Windows::Foundation::IInspectable const & pPersistFile, std::wstring const & pszUntitledPath, [Runtime::InteropServices::Out] std::wstring const & & pbstrDocumentNew, [Runtime::InteropServices::Out] int & pfCanceled);
public int SaveDocDataToFile (Microsoft.VisualStudio.Shell.Interop.VSSAVEFLAGS grfSave, object pPersistFile, string pszUntitledPath, out string pbstrDocumentNew, out int pfCanceled);
abstract member SaveDocDataToFile : Microsoft.VisualStudio.Shell.Interop.VSSAVEFLAGS * obj * string * string * int -> int
Public Function SaveDocDataToFile (grfSave As VSSAVEFLAGS, pPersistFile As Object, pszUntitledPath As String, ByRef pbstrDocumentNew As String, ByRef pfCanceled As Integer) As Integer
Parâmetros
- grfSave
- VSSAVEFLAGS
no Especifica as opções de salvamento de arquivo. Para obter mais informações, consulte VSSAVEFLAGS.
- pPersistFile
- Object
no Ponteiro para a IUnknown interface do arquivo no qual os dados do documento serão salvos.
- pszUntitledPath
- String
no O caminho do arquivo para o qual os dados do documento para um doc ainda não salvo deve ser salvo.
- pbstrDocumentNew
- String
fora Novo nome do arquivo de documento.
- pfCanceled
- Int32
fora Defina como true se o usuário abortar o salvamento clicando no botão Cancelar.
Retornos
Se o método for bem-sucedido, retornará S_OK. Se falhar, retornará um código de erro.
Comentários
Assinatura COM
De VSShell. idl:
HRESULT IVsUIShell::SaveDocDataToFile(
[in] VSSAVEFLAGS grfSave,
[in] IUnknown *pPersistFile,
[in] LPCOLESTR pszUntitledPath,
[out] BSTR *pbstrDocumentNew,
[out] BOOL *pfCanceled
);
Esse método ajuda a implementar a caixa de diálogo salvar como . O objeto de dados de documento implementa IPersistFileFormat para executar a operação de salvamento. Esse método gerencia a caixa de diálogo salvar como usando o IPersistFileFormat ponteiro passado como entrada.
O caso padrão é quando um documento salva todas as suas informações em um arquivo. Normalmente, uma operação de salvamento falhará se houver um problema com o destino (por exemplo, disco cheio, proteção contra gravação de disco, não correto e assim por diante). Não se espera que um objeto falhe em uma operação de salvamento por outros motivos do que uma opção inválida de destino. Portanto, se o salvamento tiver falhado, o usuário será informado do problema e será levado para a caixa de diálogo em que um novo destino pode ser escolhido (ou seja, a caixa de diálogo salvar como ). Para o caso em que um documento salva algumas informações em um repositório separado e outras informações para o arquivo, se o salvamento das primeiras informações no armazenamento separado falhar, não haverá nenhum ponto para tentar um destino diferente para a parte do arquivo. Nessa situação, o documento retorna um valor de OLE_E_PROMPTSAVECANCELED Save .