2.1.11.8 nlsf_uninstall_fdf

1 Description
2 Syntax
3 Parameters
4 Return
5 Examples
6 Calling from LabTalk
7 See Also

Description

Uninstall a fitting function from Origin using its FDF file, optionally specifying the category to uninstall it from.

It does not delete the FDF file- it stays in its original location.

It will not uninstall an existing fitting function from a different category than specified.

If no category is specified, the fitting function will be uninstalled from the "User Defined" category.

Note: Built in fitting functions cannot be uninstalled.

Syntax

bool nlsf_uninstall_fdf(string strFile, string strCategory)

Parameters

strFile: [input] FDF file name including full path.

strCategory: [input] Optional category. If not specified, "User Defined" is used.

Return

Returns true if fitting function is actually uninstalled.

Examples

Prior to compiling the following functions, you must run the following command via the Script or Command window:

Run.LoadOC(Originlab\nlsf_utils.c, 16);

#include <Origin.h>
#include <..\originlab\NLFitSession.h>

// Uninstalls FDF from "User Defined" category.
void UninstallMyFdf1(){
	string strFile="C:\MyFitFunc.FDF";
	nlsf_uninstall_fdf(strFile);
}

// Uninstalls FDF from "My Funcs" category. Category remains even if all FDFs are removed from it.
void UninstallMyFdf2(){
	string strFile="C:\MyFitFunc.FDF";
	nlsf_uninstall_fdf(strFile, "My Funcs");
}

Calling from LabTalk

This function may be called via LabTalk like:

run.section(dofile.ogs, OnUnInstallFDF, "C:\MyFitFunc.FDF")

But it will only uninstall from the "User Defined" category.