CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdBcfTools::OdBcfLoader Class Reference

#include <BcfLoader.h>

Static Public Member Functions

static OdBcf::OdBcfDataAccessorPtr openProject (const OdString &projectName, BcfVersion version=kVersionBcfUndefined, OdResult *result=NULL)
 

Detailed Description

A class that provides the interface for getting access to BCF data.

Definition at line 40 of file BcfLoader.h.

Member Function Documentation

◆ openProject()

static OdBcf::OdBcfDataAccessorPtr OdBcfTools::OdBcfLoader::openProject ( const OdString & projectName,
BcfVersion version = kVersionBcfUndefined,
OdResult * result = NULL )
static

Opens a BCF XML file for interaction.

Parameters
projectName[in] A string that contains the name of the BCF file.
version[in] A variable that contains the user-defined version of the BCF file.
result[out] A raw pointer to a variable containing the result of the operation.
Returns
A smart pointer to the <<exref target="https://docs.opendesign.com/tifc_api_cpp/OdBcf__OdBcfDataAccessor.html>OdBcfDataAccessor</exref> data accessor> for the project if the opening was successfull; otherwise, the method returns null pointer.
Remarks
The method unpacks BCF data into the directory and determines BCF file version. If the version cannot be determined, the file is opened according to the version specified in the input parameter. In that case, correct operation cannot be guaranteed.

The documentation for this class was generated from the following file: