Skip to main content

Module ffi

Module ffi 

Source
Expand description

C FFI bindings for sz_configtool_lib

This module provides a C-compatible interface to the Rust sz_configtool_lib library. Functions follow the pattern established by Senzing’s SzLang_helpers.h.

§Safety

All functions in this module that accept raw pointers require:

  • Non-null pointers (null pointers will return error codes)
  • Valid UTF-8 strings for string parameters
  • Memory allocated by this library must be freed with SzConfigTool_free

Macros§

handle_result 🔒

Structs§

SzConfigTool_result
Result structure for operations that return modified configuration JSON

Constants§

_DLEXPORT 🔒

Statics§

LAST_ERROR 🔒
LAST_ERROR_CODE 🔒

Functions§

SzConfigTool_addAttribute
Add an attribute to the configuration
SzConfigTool_addBehaviorOverride
Add a behavior override for a feature based on usage type
SzConfigTool_addCandidateFunction
Add a candidate function (placeholder - not implemented)
SzConfigTool_addComparisonCall
Add a comparison call with JSON element list
SzConfigTool_addComparisonFunction
Add a comparison function
SzConfigTool_addComparisonThreshold
Add a comparison threshold
SzConfigTool_addConfigSection
Add a config section
SzConfigTool_addConfigSectionField
Add a field to a config section (returns tuple)
SzConfigTool_addDataSource
Add a data source to the configuration
SzConfigTool_addDistinctCall
Add a distinct call with JSON element list
SzConfigTool_addDistinctFunction
Add a distinct function
SzConfigTool_addElement
Add an element with JSON configuration
SzConfigTool_addExpressionCall
Add an expression call with JSON element list
SzConfigTool_addExpressionFunction
Add an expression function
SzConfigTool_addFeature
Add a feature with JSON configuration
SzConfigTool_addFragment
Add a fragment
SzConfigTool_addGenericThreshold
Add a generic threshold
SzConfigTool_addMatchingFunction
Add a matching function (placeholder - not implemented)
SzConfigTool_addRule
Add a rule with JSON configuration
SzConfigTool_addScoringFunction
Add a scoring function (placeholder - not implemented)
SzConfigTool_addStandardizeCall
Add a standardize call
SzConfigTool_addStandardizeFunction
Add a standardize function
SzConfigTool_addToSsnLast4Hash
Add a name to the SSN_LAST4 hash
SzConfigTool_addValidationFunction
Add a validation function (placeholder - not implemented)
SzConfigTool_clearLastError
Clear the last error
SzConfigTool_cloneGenericPlan
Clone a generic plan
SzConfigTool_deleteAttribute
Delete an attribute from the configuration
SzConfigTool_deleteBehaviorOverride
Delete a behavior override
SzConfigTool_deleteCandidateFunction
Delete a candidate function (placeholder - not implemented)
SzConfigTool_deleteComparisonCall
Delete a comparison call by ID
SzConfigTool_deleteComparisonFunction
Delete a comparison function
SzConfigTool_deleteComparisonThreshold
Delete a comparison threshold
SzConfigTool_deleteDataSource
Delete a data source from the configuration
SzConfigTool_deleteDistinctCall
Delete a distinct call by ID
SzConfigTool_deleteDistinctFunction
Delete a distinct function by code
SzConfigTool_deleteElement
Delete an element by code
SzConfigTool_deleteExpressionCall
Delete an expression call by ID
SzConfigTool_deleteExpressionFunction
Delete an expression function
SzConfigTool_deleteFeature
Delete a feature by code or ID
SzConfigTool_deleteFragment
Delete a fragment
SzConfigTool_deleteFromSsnLast4Hash
Delete a name from the SSN_LAST4 hash
SzConfigTool_deleteGenericThreshold
Delete a generic threshold
SzConfigTool_deleteMatchingFunction
Delete a matching function (placeholder - not implemented)
SzConfigTool_deleteRule
Delete a rule
SzConfigTool_deleteScoringFunction
Delete a scoring function (placeholder - not implemented)
SzConfigTool_deleteStandardizeCall
Delete a standardize call
SzConfigTool_deleteStandardizeFunction
Delete a standardize function
SzConfigTool_deleteValidationFunction
Delete a validation function (placeholder - not implemented)
SzConfigTool_free
Free memory allocated by this library
SzConfigTool_getAttribute
Get an attribute from the configuration (returns JSON object string)
SzConfigTool_getCandidateFunction
Get a candidate function (placeholder - not implemented)
SzConfigTool_getComparisonCall
Get a comparison call by ID
SzConfigTool_getComparisonFunction
Get a comparison function
SzConfigTool_getCompatibilityVersion
Get the compatibility version
SzConfigTool_getConfigSection
Get a config section
SzConfigTool_getDataSource
Get a data source by code
SzConfigTool_getDistinctCall
Get a distinct call by ID
SzConfigTool_getDistinctFunction
Get a distinct function by code
SzConfigTool_getElement
Get an element from the configuration (returns JSON object string)
SzConfigTool_getExpressionCall
Get an expression call by ID
SzConfigTool_getExpressionFunction
Get an expression function
SzConfigTool_getFeature
Get a feature from the configuration (returns JSON object string)
SzConfigTool_getFragment
Get a fragment by code or ID
SzConfigTool_getLastError
Get the last error message
SzConfigTool_getLastErrorCode
Get the last error code
SzConfigTool_getMatchingFunction
Get a matching function (placeholder - not implemented)
SzConfigTool_getRule
Get a rule by code or ID
SzConfigTool_getScoringFunction
Get a scoring function (placeholder - not implemented)
SzConfigTool_getStandardizeCall
Get a standardize call
SzConfigTool_getStandardizeFunction
Get a standardize function
SzConfigTool_getThreshold
Get a threshold by ID
SzConfigTool_getValidationFunction
Get a validation function (placeholder - not implemented)
SzConfigTool_getVersion
Get the configuration version
SzConfigTool_listAttributes
List all attributes in the configuration (returns JSON array string)
SzConfigTool_listBehaviorOverrides
List all behavior overrides
SzConfigTool_listCandidateFunctions
List all candidate functions (placeholder - not implemented)
SzConfigTool_listComparisonCalls
List all comparison calls
SzConfigTool_listComparisonFunctions
List all comparison functions
SzConfigTool_listComparisonThresholds
List all comparison thresholds
SzConfigTool_listConfigSections
List all config sections
SzConfigTool_listDataSources
List all data sources in the configuration (returns JSON array string)
SzConfigTool_listDistinctCalls
List all distinct calls
SzConfigTool_listDistinctFunctions
List all distinct functions
SzConfigTool_listElements
List all elements in the configuration (returns JSON array string)
SzConfigTool_listExpressionCalls
List all expression calls
SzConfigTool_listExpressionFunctions
List all expression functions
SzConfigTool_listFeatures
List all features in the configuration (returns JSON array string)
SzConfigTool_listFragments
List all fragments
SzConfigTool_listGenericPlans
List generic plans
SzConfigTool_listGenericThresholds
List all generic thresholds
SzConfigTool_listMatchingFunctions
List all matching functions (placeholder - not implemented)
SzConfigTool_listRules
List all rules
SzConfigTool_listScoringFunctions
List all scoring functions (placeholder - not implemented)
SzConfigTool_listStandardizeCalls
List all standardize calls
SzConfigTool_listStandardizeFunctions
List all standardize functions
SzConfigTool_listSystemParameters
List system parameters
SzConfigTool_listValidationFunctions
List all validation functions (placeholder - not implemented)
SzConfigTool_removeConfigSection
Remove a config section
SzConfigTool_removeConfigSectionField
Remove a field from a config section (returns tuple)
SzConfigTool_setAttribute
Set (update) an attribute’s properties
SzConfigTool_setCandidateFunction
Set (update) a candidate function (placeholder - not implemented)
SzConfigTool_setComparisonCall
Set (update) a comparison call
SzConfigTool_setComparisonFunction
Set (update) a comparison function
SzConfigTool_setComparisonThreshold
Set (update) a comparison threshold
SzConfigTool_setDataSource
Set (update) a data source
SzConfigTool_setDistinctCall
Set (update) a distinct call
SzConfigTool_setDistinctFunction
Set (update) a distinct function
SzConfigTool_setElement
Set (update) element properties with JSON
SzConfigTool_setExpressionCall
Set (update) an expression call
SzConfigTool_setExpressionFunction
Set (update) an expression function
SzConfigTool_setFeature
Set (update) feature properties with JSON
SzConfigTool_setFragmentWithJson
Set/update a fragment with JSON parameters
SzConfigTool_setGenericPlan
Set/update a generic plan
SzConfigTool_setGenericThreshold
Set (update) a generic threshold
SzConfigTool_setMatchingFunction
Set (update) a matching function (placeholder - not implemented)
SzConfigTool_setRule
Set/update a rule with JSON configuration
SzConfigTool_setScoringFunction
Set (update) a scoring function (placeholder - not implemented)
SzConfigTool_setStandardizeCall
Set (update) a standardize call
SzConfigTool_setStandardizeFunction
Set (update) a standardize function
SzConfigTool_setSystemParameterWithJson
Set a system parameter with JSON value
SzConfigTool_setValidationFunction
Set (update) a validation function (placeholder - not implemented)
SzConfigTool_updateCompatibilityVersion
Update the compatibility version
SzConfigTool_updateFeatureVersion
Update the feature version
SzConfigTool_verifyCompatibilityVersion
Verify compatibility version
clear_error 🔒
set_error 🔒