Module bindings_generated Copy item path Source SzConfigMgr_getConfigRegistry_result SzConfigMgr_getConfig_result SzConfigMgr_getDefaultConfigID_result SzConfigMgr_registerConfig_result SzConfig_create_result SzConfig_export_result SzConfig_getDataSourceRegistry_result SzConfig_load_result SzConfig_registerDataSource_result SzDiagnostic_checkRepositoryPerformance_result SzDiagnostic_getFeature_result SzDiagnostic_getRepositoryInfo_result SzProduct_validateLicenseFile_result SzProduct_validateLicenseStringBase64_result Sz_addRecordWithInfo_result Sz_deleteRecordWithInfo_result Sz_exportCSVEntityReport_result Sz_exportJSONEntityReport_result Sz_fetchNext_result Sz_findInterestingEntitiesByEntityID_result Sz_findInterestingEntitiesByRecordID_result Sz_findNetworkByEntityID_V2_result Sz_findNetworkByEntityID_result Sz_findNetworkByRecordID_V2_result Sz_findNetworkByRecordID_result Sz_findPathByEntityIDIncludingSource_V2_result Sz_findPathByEntityIDIncludingSource_result Sz_findPathByEntityIDWithAvoids_V2_result Sz_findPathByEntityIDWithAvoids_result Sz_findPathByEntityID_V2_result Sz_findPathByEntityID_result Sz_findPathByRecordIDIncludingSource_V2_result Sz_findPathByRecordIDIncludingSource_result Sz_findPathByRecordIDWithAvoids_V2_result Sz_findPathByRecordIDWithAvoids_result Sz_findPathByRecordID_V2_result Sz_findPathByRecordID_result Sz_getActiveConfigID_result Sz_getEntityByEntityID_V2_result Sz_getEntityByEntityID_result Sz_getEntityByRecordID_V2_result Sz_getEntityByRecordID_result Sz_getRecordPreview_result Sz_getRecord_V2_result Sz_getRecord_result Sz_getRedoRecord_result Sz_getVirtualEntityByRecordID_V2_result Sz_getVirtualEntityByRecordID_result Sz_howEntityByEntityID_V2_result Sz_howEntityByEntityID_result Sz_processRedoRecordWithInfo_result Sz_reevaluateEntityWithInfo_result Sz_reevaluateRecordWithInfo_result Sz_searchByAttributes_V2_result Sz_searchByAttributes_V3_result Sz_searchByAttributes_result Sz_stats_result Sz_whyEntities_V2_result Sz_whyEntities_result Sz_whyRecordInEntity_V2_result Sz_whyRecordInEntity_result Sz_whyRecords_V2_result Sz_whyRecords_result Sz_whySearch_V2_result Sz_whySearch_result SzConfigMgr_clearLastException ⚠ @brief
This function clears the last exception thrown in SzConfigMgr SzConfigMgr_destroy ⚠ @brief
This method will destroy and perform cleanup for the Sz Config object. It
should be called after all other calls are complete. SzConfigMgr_getConfig ⚠ @brief Retrieve configuration information from the backend data store SzConfigMgr_getConfigRegistry ⚠ @brief Retrieve a list of configurations from the backend data store SzConfigMgr_getConfigRegistry_helper ⚠ SzConfigMgr_getConfig_helper ⚠ SzConfigMgr_getDefaultConfigID ⚠ @brief Get the default configuration identifier from the backend data store SzConfigMgr_getDefaultConfigID_helper ⚠ SzConfigMgr_getLastException ⚠ @brief
This function retrieves the last exception thrown in SzConfigMgr
@return number of bytes copied into buffer SzConfigMgr_getLastExceptionCode ⚠ @brief
This function retrieves the code of the last exception thrown in SzConfigMgr
@return number of bytes copied into buffer SzConfigMgr_init ⚠ @brief
This method will initialize the Sz Config Manager object. It must be called
prior to any other calls. SzConfigMgr_registerConfig ⚠ @brief Registers a configuration handle with the backend data store SzConfigMgr_registerConfig_helper ⚠ SzConfigMgr_replaceDefaultConfigID ⚠ @brief Replace the default configuration identifier in the backend data store SzConfigMgr_setDefaultConfigID ⚠ @brief Set the default configuration identifier in the backend data store SzConfig_clearLastException ⚠ @brief
This function clears the last exception thrown in SzConfig SzConfig_close ⚠ @brief
This method cleans up the SzConfig object pointed to by the handle. SzConfig_close_helper ⚠ SzConfig_create ⚠ @brief
This method creates a stock Sz JSON config from the template config SzConfig_create_helper ⚠ SzConfig_destroy ⚠ @brief
This method will destroy and perform cleanup for the Sz Config object. It
should be called after all other calls are complete. SzConfig_export ⚠ @brief
This method saves the SzConfig object into a JSON string. SzConfig_export_helper ⚠ SzConfig_getDataSourceRegistry ⚠ SzConfig_getDataSourceRegistry_helper ⚠ SzConfig_getLastException ⚠ @brief
This function retrieves the last exception thrown in SzConfig
@return number of bytes copied into buffer SzConfig_getLastExceptionCode ⚠ @brief
This function retrieves the code of the last exception thrown in SzConfig
@return number of bytes copied into buffer SzConfig_init ⚠ @brief
This method will initialize the SzConfig object. It must be called
prior to any other calls. SzConfig_load ⚠ @brief
This method initializes the SzConfig object from a JSON string. Any time you need to edit an existing
config from an existing repository you will want to use this method to be able to modify it. SzConfig_load_helper ⚠ SzConfig_registerDataSource ⚠ SzConfig_registerDataSource_helper ⚠ SzConfig_unregisterDataSource ⚠ SzConfig_unregisterDataSource_helper ⚠ SzDiagnostic_checkRepositoryPerformance ⚠ @brief Check the performance metrics of the datastore SzDiagnostic_checkRepositoryPerformance_helper ⚠ SzDiagnostic_clearLastException ⚠ @brief
This function clears the last exception thrown in SzDiagnostic SzDiagnostic_destroy ⚠ @brief
This method will destroy and perform cleanup for the Sz diagnostic object. It
should be called after all other calls are complete. SzDiagnostic_getFeature ⚠ THESE FUNCTIONS ARE UNSUPPORTED AND UNDOCUMENTED. ANY USE IS WITHOUT WARRANTY OF ANY KIND. SzDiagnostic_getFeature_helper ⚠ THIS FUNCTION IS UNSUPPORTED AND UNDOCUMENTED. ANY USE IS WITHOUT WARRANTY OF ANY KIND. SzDiagnostic_getLastException ⚠ @brief
This function retrieves the last exception thrown in SzDiagnostic
@return number of bytes copied into buffer SzDiagnostic_getLastExceptionCode ⚠ @brief
This function retrieves the code of the last exception thrown in SzDiagnostic
@return number of bytes copied into buffer SzDiagnostic_getRepositoryInfo ⚠ SzDiagnostic_getRepositoryInfo_helper ⚠ SzDiagnostic_init ⚠ @brief
This method will initialize the Sz diagnostic object. It must be called
prior to any other calls. SzDiagnostic_initWithConfigID ⚠ SzDiagnostic_purgeRepository ⚠ @brief
This is used to purge all data from an existing repository
@return Returns 0 for success, or an appropriate error code. SzDiagnostic_reinit ⚠ @brief
This method will re-initialize the Sz diagnostic object. SzHelper_free ⚠ SzProduct_clearLastException ⚠ @brief
This function clears the last exception thrown in SzProduct SzProduct_destroy ⚠ @brief
This method will destroy and perform cleanup for the Sz product object. It
should be called after all other calls are complete. SzProduct_getLastException ⚠ @brief
This function retrieves the last exception thrown in SzProduct
@return number of bytes copied into buffer SzProduct_getLastExceptionCode ⚠ @brief
This function retrieves the code of the last exception thrown in SzProduct
@return number of bytes copied into buffer SzProduct_getLicense ⚠ @brief
This function is used to return the license information SzProduct_getVersion ⚠ @brief
This function is used to return the version and build information SzProduct_init ⚠ @brief
This method will initialize the Sz product object. It must be called
prior to any other calls. SzProduct_validateLicenseFile ⚠ @brief
This function is used to validate an external license file for validity.
If it is not valid, information on why will be returned through the
error buffer parameters. SzProduct_validateLicenseFile_helper ⚠ SzProduct_validateLicenseStringBase64 ⚠ SzProduct_validateLicenseStringBase64_helper ⚠ Sz_addRecord ⚠ @brief
This method is used to add entity data into the system. This adds or
updates a single entity observation record, by adding features for the
observation. Sz_addRecordWithInfo ⚠ Sz_addRecordWithInfo_helper ⚠ Sz_clearLastException ⚠ @brief
This function clears the last exception thrown in libSz Sz_closeExportReport ⚠ @brief
This function closes an export handle, to clean up system resources. Sz_closeExportReport_helper ⚠ Sz_countRedoRecords ⚠ @brief Get the number of records contained in the internal redo-queue Sz_deleteRecord ⚠ @brief
This method is used to delete observation data from the system. This
removes a single entity observation record, by removing all of its
feature data and the observation itself. Sz_deleteRecordWithInfo ⚠ Sz_deleteRecordWithInfo_helper ⚠ Sz_destroy ⚠ @brief
This method will destroy and perform cleanup for the Sz processing object. It
should be called after all other calls are complete. Sz_exportCSVEntityReport ⚠ @brief
This is used to export entity data from known entities. This function
returns an export-handle that can be read from to get the export data
in CSV format. The export-handle should be read using the “Sz_fetchNext”
function, and closed when work is complete. The first output row returned
by the export-handle contains the JSON column headers as a string. Each
following row contains the exported entity data. Sz_exportCSVEntityReport_helper ⚠ Sz_exportJSONEntityReport ⚠ @brief
This is used to export entity data from known entities. This function
returns an export-handle that can be read from to get the export data
in JSON format. The export-handle should be read using the “Sz_fetchNext”
function, and closed when work is complete. Each output row contains the
exported entity data for a single resolved entity. Sz_exportJSONEntityReport_helper ⚠ Sz_fetchNext ⚠ @brief
This function is used to read entity data from an export handle,
one data row at a time. Sz_fetchNext_helper ⚠ Sz_findInterestingEntitiesByEntityID ⚠ @brief
This method determines what interesting entities exist around a particular resolved entity Sz_findInterestingEntitiesByEntityID_helper ⚠ Sz_findInterestingEntitiesByRecordID ⚠ Sz_findInterestingEntitiesByRecordID_helper ⚠ Sz_findNetworkByEntityID ⚠ @brief
This method is used to find a network of entity relationships, surrounding the paths between
a set of entities. Sz_findNetworkByEntityID_V2 ⚠ Sz_findNetworkByEntityID_V2_helper ⚠ Sz_findNetworkByEntityID_helper ⚠ Sz_findNetworkByRecordID ⚠ Sz_findNetworkByRecordID_V2 ⚠ Sz_findNetworkByRecordID_V2_helper ⚠ Sz_findNetworkByRecordID_helper ⚠ Sz_findPathByEntityID ⚠ @brief
This method is used to find a relationship path between entities. Sz_findPathByEntityIDIncludingSource ⚠ @brief
This method is used to find a relationship path between entities, that avoids
a particular set of entities, and also requires at least one data source from a
set to be part of the path. Sz_findPathByEntityIDIncludingSource_V2 ⚠ Sz_findPathByEntityIDIncludingSource_V2_helper ⚠ Sz_findPathByEntityIDIncludingSource_helper ⚠ Sz_findPathByEntityIDWithAvoids ⚠ @brief
This method is used to find a relationship path between entities, that avoids
a particular set of entities. Sz_findPathByEntityIDWithAvoids_V2 ⚠ Sz_findPathByEntityIDWithAvoids_V2_helper ⚠ Sz_findPathByEntityIDWithAvoids_helper ⚠ Sz_findPathByEntityID_V2 ⚠ Sz_findPathByEntityID_V2_helper ⚠ Sz_findPathByEntityID_helper ⚠ Sz_findPathByRecordID ⚠ Sz_findPathByRecordIDIncludingSource ⚠ Sz_findPathByRecordIDIncludingSource_V2 ⚠ Sz_findPathByRecordIDIncludingSource_V2_helper ⚠ Sz_findPathByRecordIDIncludingSource_helper ⚠ Sz_findPathByRecordIDWithAvoids ⚠ Sz_findPathByRecordIDWithAvoids_V2 ⚠ Sz_findPathByRecordIDWithAvoids_V2_helper ⚠ Sz_findPathByRecordIDWithAvoids_helper ⚠ Sz_findPathByRecordID_V2 ⚠ Sz_findPathByRecordID_V2_helper ⚠ Sz_findPathByRecordID_helper ⚠ Sz_getActiveConfigID ⚠ @brief
This method returns an identifier for the loaded Sz engine configuration Sz_getActiveConfigID_helper ⚠ Sz_getEntityByEntityID ⚠ @brief
This method is used to retrieve information about a specific resolved
entity. The information is returned as a JSON document. Sz_getEntityByEntityID_V2 ⚠ Sz_getEntityByEntityID_V2_helper ⚠ Sz_getEntityByEntityID_helper ⚠ Sz_getEntityByRecordID ⚠ Sz_getEntityByRecordID_V2 ⚠ Sz_getEntityByRecordID_V2_helper ⚠ Sz_getEntityByRecordID_helper ⚠ Sz_getLastException ⚠ @brief
This function retrieves the last exception thrown in the engine
@return number of bytes copied into buffer Sz_getLastExceptionCode ⚠ @brief
This function retrieves the code of the last exception thrown in the engine
@return number of bytes copied into buffer Sz_getRecord ⚠ @brief
This method is used to retrieve a stored record. Sz_getRecordPreview ⚠ @brief
This method gives a similar data response to getRecord but you supply
the record instead of it being loaded. Sz_getRecordPreview_helper ⚠ Sz_getRecord_V2 ⚠ Sz_getRecord_V2_helper ⚠ Sz_getRecord_helper ⚠ Sz_getRedoRecord ⚠ @brief Retrieve a record contained in the internal redo-queue Sz_getRedoRecord_helper ⚠ Sz_getVirtualEntityByRecordID ⚠ @brief
This method gives information on how an entity composed of a given set of records would look Sz_getVirtualEntityByRecordID_V2 ⚠ Sz_getVirtualEntityByRecordID_V2_helper ⚠ Sz_getVirtualEntityByRecordID_helper ⚠ Sz_howEntityByEntityID ⚠ @brief
This method gives information on how entities were constructed from their base records. Sz_howEntityByEntityID_V2 ⚠ Sz_howEntityByEntityID_V2_helper ⚠ Sz_howEntityByEntityID_helper ⚠ Sz_init ⚠ @brief
This method will initialize the Sz processing object. It must be called
once per process, prior to any other calls. Sz_initWithConfigID ⚠ Sz_primeEngine ⚠ @brief
This method may optionally be called to pre-initialize some of the heavier weight
internal resources of the Sz engine. Sz_processRedoRecord ⚠ @brief Process a record contained in the internal redo-queue Sz_processRedoRecordWithInfo ⚠ Sz_processRedoRecordWithInfo_helper ⚠ Sz_reevaluateEntity ⚠ Sz_reevaluateEntityWithInfo ⚠ Sz_reevaluateEntityWithInfo_helper ⚠ Sz_reevaluateRecord ⚠ @brief Reevaluate an entity in the datastore. Sz_reevaluateRecordWithInfo ⚠ Sz_reevaluateRecordWithInfo_helper ⚠ Sz_reinit ⚠ @brief
This method will re-initialize the Sz processing object. Sz_searchByAttributes ⚠ @brief
This method searches for entities that contain attribute information
that are relevant to a set of input search attributes. Sz_searchByAttributes_V2 ⚠ Sz_searchByAttributes_V3 ⚠ Sz_searchByAttributes_V2_helper ⚠ Sz_searchByAttributes_V3_helper ⚠ Sz_searchByAttributes_helper ⚠ Sz_stats ⚠ @brief
This method returns a JSON document that provides basic statistics on
the requests made through the Sz object. It returns things such as the
number of records loaded, the duration of processing time, the number of
retries made, etc. Sz_stats_helper ⚠ Sz_whyEntities ⚠ @brief
This method determines how entities are related to each other. Sz_whyEntities_V2 ⚠ Sz_whyEntities_V2_helper ⚠ Sz_whyEntities_helper ⚠ Sz_whyRecordInEntity ⚠ @brief
This method determines why a particular record is included in its resolved entity. Sz_whyRecordInEntity_V2 ⚠ Sz_whyRecordInEntity_V2_helper ⚠ Sz_whyRecordInEntity_helper ⚠ Sz_whyRecords ⚠ @brief
This method determines how records are related to each other. Sz_whyRecords_V2 ⚠ Sz_whyRecords_V2_helper ⚠ Sz_whyRecords_helper ⚠ Sz_whySearch ⚠ @brief
This method determines how a search record relates to an existing entity. Sz_whySearch_V2 ⚠ Sz_whySearch_V2_helper ⚠ Sz_whySearch_helper ⚠ ConfigHandle ExportHandle