OpenFile

HRESULT OpenFile(path: [in] BSTR, params: [in] BSTR, result: [out, retval] VARIANT_BOOL*)

Description

Opens the document file which will be edited and saved afterwards.

Parameters

pathBSTR

The path to the file to be opened together with its name and extension.

paramsBSTR

The parameters needed for the correct file opening (most commonly, the encoding is used for the txt and csv file types or the delimiter for the csv files, for other file types this is just an empty string). The parameters are added in the form of XML tags, where m_nCsvTxtEncoding is used for the text encoding and m_nCsvDelimiter is used for the delimiter. You can find all the supported values for the encoding in this file. The supported values for the csv delimiters include:

• 0 - no delimiter;
• 1 - tab;
• 2 - semicolon;
• 3 - colon;
• 4 - comma;
• 5 - space.

resultVARIANT_BOOL*

Specifies if the operation of opening a file is successful or not.

Example

COM

CoInitialize(NULL);
IONLYOFFICEDocBuilder* oBuilder = NULL;
VARIANT_BOOL b;
oBuilder->Initialize();
oBuilder->OpenFile("text-document.csv", "<m_nCsvTxtEncoding>46</m_nCsvTxtEncoding><m_nCsvDelimiter>4</m_nCsvDelimiter>", &b);
oBuilder->Dispose();

.docbuilder

builder.OpenFile("text-document.csv", "<m_nCsvTxtEncoding>46</m_nCsvTxtEncoding><m_nCsvDelimiter>4</m_nCsvDelimiter>")