exponenta event banner

compiler.build. CSharedLibraryOptions

Параметры построения общих библиотек C

Описание

пример

opts = compiler.build.CSharedLibraryOptions(FunctionFiles) создает объект параметров общей библиотеки C по умолчанию с использованием файлов MATLAB ®FunctionFiles. Используйте CSharedLibraryOptions объект в качестве входных данных для compiler.build.cSharedLibrary функция.

пример

opts = compiler.build.CSharedLibraryOptions(FunctionFiles,Name,Value) создает CSharedLibraryOptions с параметрами, заданными с помощью одного или нескольких аргументов «имя-значение». Параметры включают имя библиотеки, папку вывода и дополнительные файлы для включения.

Примеры

свернуть все

Создать CSharedLibraryOptions с использованием ввода файла.

Для этого примера используйте файл magicsquare.m расположен в matlabroot\extern\examples\compiler.

appFile = fullfile(matlabroot,'extern','examples','compiler','magicsquare.m');
opts = compiler.build.CSharedLibraryOptions(appFile)
opts = 

  CSharedLibraryOptions with properties:

           EmbedArchive: on
          FunctionFiles: {'C:\Program Files\MATLAB\R2021a\extern\examples\compiler\magicsquare.m'}
             DebugBuild: off
            LibraryName: 'magicsquare'
         LibraryVersion: '1.0.0.0'
        AdditionalFiles: {}
    AutoDetectDataFiles: on
                Verbose: off
              OutputDir: '.\magicsquarecSharedLibrary'

Можно изменить значения свойств существующего CSharedLibraryOptions с использованием точечной нотации. Например, включить подробный вывод.

opts.Verbose = 'on'
opts = 

  CSharedLibraryOptions with properties:

           EmbedArchive: on
          FunctionFiles: {'C:\Program Files\MATLAB\R2021a\extern\examples\compiler\magicsquare.m'}
             DebugBuild: off
            LibraryName: 'magicsquare'
         LibraryVersion: '1.0.0.0'
        AdditionalFiles: {}
    AutoDetectDataFiles: on
                Verbose: on
              OutputDir: '.\magicsquarecSharedLibrary'

Используйте CSharedLibraryOptions объект в качестве входных данных для compiler.build.cSharedLibrary для построения общей библиотеки C.

buildResults = compiler.build.cSharedLibrary(opts);

Создать CSharedLibraryOptions и настройте его с помощью аргументов «имя-значение».

Для этого примера используйте файл magicsquare.m расположен в matlabroot\extern\examples\compiler. Используйте аргументы name-value, чтобы указать выходной каталог и отключить автоматическое обнаружение файлов данных.

appFile = fullfile(matlabroot,'extern','examples','compiler','magicsquare.m');
opts = compiler.build.CSharedLibraryOptions(appFile,...
    'OutputDir','D:\Documents\MATLAB\work\MagicSquareLib',...
    'AutoDetectDataFiles','off')
opts = 

  CSharedLibraryOptions with properties:

           EmbedArchive: on
          FunctionFiles: {'C:\Program Files\MATLAB\R2021a\extern\examples\compiler\magicsquare.m'}
             DebugBuild: off
            LibraryName: 'magicsquare'
         LibraryVersion: '1.0.0.0'
        AdditionalFiles: {}
    AutoDetectDataFiles: off
                Verbose: off
              OutputDir: 'D:\Documents\MATLAB\work\MagicSquareLib'

Можно изменить значения свойств существующего CSharedLibraryOptions с использованием точечной нотации. Например, включить подробный вывод.

opts.Verbose = 'on'
opts = 

  CSharedLibraryOptions with properties:

           EmbedArchive: on
          FunctionFiles: {'C:\Program Files\MATLAB\R2021a\extern\examples\compiler\magicsquare.m'}
             DebugBuild: off
            LibraryName: 'magicsquare'
         LibraryVersion: '1.0.0.0'
        AdditionalFiles: {}
    AutoDetectDataFiles: off
                Verbose: on
              OutputDir: 'D:\Documents\MATLAB\work\MagicSquareLib'

Используйте CSharedLibraryOptions объект в качестве входных данных для compiler.build.cSharedLibrary для построения общей библиотеки C.

buildResults = compiler.build.cSharedLibrary(opts);

Входные аргументы

свернуть все

Файлы, реализующие функции MATLAB, указанные как символьный вектор, строковый скаляр, строковый массив или массив ячеек символьных векторов. Пути к файлам могут быть относительно текущей рабочей папки или абсолютными. Файлы должны иметь .m расширение.

Пример: ["myfunc1.m","myfunc2.m"]

Типы данных: char | string | cell

Аргументы пары «имя-значение»

Укажите дополнительные пары, разделенные запятыми Name,Value аргументы. Name является именем аргумента и Value - соответствующее значение. Name должен отображаться внутри кавычек. Можно указать несколько аргументов пары имен и значений в любом порядке как Name1,Value1,...,NameN,ValueN.

Пример: 'Verbose','on'

Дополнительные файлы для включения в общую библиотеку C, указанные как вектор символов, скаляр строк, массив строк или массив ячеек векторов символов. Пути к файлам могут быть относительно текущей рабочей папки или абсолютными.

Пример: 'AdditionalFiles',["myvars.mat","data.txt"]

Типы данных: char | string | cell

Флажок для автоматического включения файлов данных, указанный как 'on' или 'off'или как числовое или логическое 1 (true) или 0 (false). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом, можно использовать значение этого свойства в качестве логического значения. Значение сохраняется как логическое значение типа вкл/выкл matlab.lang.OnOffSwitchState.

  • Если для этого свойства задано значение 'on', то файлы данных, которые вы предоставляете в качестве входных данных для определенных функций (таких как load и fopen) автоматически включаются в общую библиотеку.

  • Если для этого свойства задано значение 'off', то необходимо добавить файлы данных в общую библиотеку с помощью AdditionalFiles вариант.

Пример: 'AutoDetectDataFiles','off'

Типы данных: logical

Флаг для включения символов отладки, указанный как 'on' или 'off'или как числовое или логическое 1 (true) или 0 (false). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом, можно использовать значение этого свойства в качестве логического значения. Значение сохраняется как логическое значение типа вкл/выкл matlab.lang.OnOffSwitchState.

  • Если для этого свойства задано значение 'on', то скомпилированная библиотека содержит символы отладки.

  • Если для этого свойства задано значение 'off', то скомпилированная библиотека не содержит символов отладки.

Пример: 'DebugBuild','on'

Типы данных: logical

Флаг для встраивания развертываемого архива, указанный как 'on' или 'off'или как числовое или логическое 1 (true) или 0 (false). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом, можно использовать значение этого свойства в качестве логического значения. Значение сохраняется как логическое значение типа вкл/выкл matlab.lang.OnOffSwitchState.

  • Если для этого свойства задано значение 'on', затем функция встраивает развертываемый архив в общую библиотеку.

  • Если для этого свойства задано значение 'off', затем функция генерирует развертываемый архив в виде отдельного файла.

Пример: 'EmbedArchive','off'

Типы данных: logical

Имя общей библиотеки C, указанное как вектор символов или строковый скаляр. Имя по умолчанию созданной библиотеки является первой записью FunctionFiles аргумент.

Пример: 'LibraryName','mymagic'

Типы данных: char | string

Путь к выходному каталогу, в котором сохраняются файлы построения, определяемый как вектор символов или строковый скаляр. Путь может быть относительно текущего рабочего каталога или абсолютным.

Именем по умолчанию папки построения является имя библиотеки, добавляемое с cSharedLibrary.

Пример: 'OutputDir','D:\Documents\MATLAB\work\mymagiccSharedLibrary'

Типы данных: char | string

Флаг для управления подробностью построения, указанный как 'on' или 'off'или как числовое или логическое 1 (true) или 0 (false). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом, можно использовать значение этого свойства в качестве логического значения. Значение сохраняется как логическое значение типа вкл/выкл matlab.lang.OnOffSwitchState.

  • Если для этого свойства задано значение 'on'затем в окне команд MATLAB отображается информация о ходе выполнения, указывающая на вывод компилятора в процессе построения.

  • Если для этого свойства задано значение 'off', то командное окно не отображает информацию о ходе выполнения.

Пример: 'Verbose','on'

Типы данных: logical

Выходные аргументы

свернуть все

Параметры построения библиотеки C, возвращенные как CSharedLibraryOptions объект.

Представлен в R2021a