Hallo, dies ist ein Test.

PWD: /www/data-lst1/unixsoft/unixsoft/kaempfer/.public_html

Running in File Mode
Relative path: ./../../../../../../usr/man/man3rad/webuiprefs.3rad
Real path: /usr/share/man/man3rad/webuiprefs-1.3rad
Zurück

'\" t .\" Title: webuiprefs-1 .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> .\" Date: 2017-02-01 .\" Manual: RAD Module Definitions .\" Source: Solaris 11.4 .\" Language: English .\" .TH "WEBUIPREFS\-1" "3rad" "2017\-02\-01" "Solaris 11.4" "RAD Module Definitions" .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" webuiprefs \- API for WebUI preferences .SH "SYNOPSIS" .nf #include <rad/client/1/webuiprefs\&.h> cc [ flag\&.\&.\&. ] file\&.\&.\&. \fB\-lwebuiprefs1_client\fR [ library\&.\&.\&. ] .fi .SS "interface Preferences" .nf const char *\ \&apps\ \&; (ro) .fi .nf const char *\ \&system\ \&; (ro) .fi .nf const char *\ \&user\ \&; (rw) .fi .nf const char **\ \&import_formats\ \&; (ro) .fi .nf .HP \w'rc_err_t\ \fBwebuiprefs_Preferences_initialize\fR('u .R rc_err_t \fBwebuiprefs_Preferences_initialize\fR(rc_instance_t\ *inst, . const\ char\ *base_dir, . const\ char\ *username, . webuiprefs_PreferencesError_t\ **error); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBwebuiprefs_Preferences_validate_json\fR('u .R rc_err_t \fBwebuiprefs_Preferences_validate_json\fR(rc_instance_t\ *inst, . const\ char\ *json_string, . boolean_t\ *is_schema, . const\ char\ *import_format, . char\ **result); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBwebuiprefs_Preferences_import_files\fR('u .R rc_err_t \fBwebuiprefs_Preferences_import_files\fR(rc_instance_t\ *inst, . const\ char\ *format_name, . const\ char\ **files, . int\ files_count, . webuiprefs_ImportSummary_t\ **result, . webuiprefs_PreferencesError_t\ **error); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBwebuiprefs_Preferences_import_string\fR('u .R rc_err_t \fBwebuiprefs_Preferences_import_string\fR(rc_instance_t\ *inst, . const\ char\ *format_name, . const\ char\ *json_string, . char\ **result, . webuiprefs_PreferencesError_t\ **error); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBwebuiprefs_Preferences_export_string\fR('u .R rc_err_t \fBwebuiprefs_Preferences_export_string\fR(rc_instance_t\ *inst, . const\ char\ *format_name, . const\ char\ *json_string, . char\ **result, . webuiprefs_PreferencesError_t\ **error); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBwebuiprefs_Preferences_export_by_id\fR('u .R rc_err_t \fBwebuiprefs_Preferences_export_by_id\fR(rc_instance_t\ *inst, . const\ char\ *format_name, . const\ char\ **id_list, . int\ id_list_count, . char\ **result, . webuiprefs_PreferencesError_t\ **error); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBwebuiprefs_Preferences_get_exportable_ids\fR('u .R rc_err_t \fBwebuiprefs_Preferences_get_exportable_ids\fR(rc_instance_t\ *inst, . const\ char\ *format_name, . webuiprefs_ExportableIds_t\ ***result, . int\ *result_cnt, . webuiprefs_PreferencesError_t\ **error); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBwebuiprefs_Preferences_verify_existing_ids\fR('u .R rc_err_t \fBwebuiprefs_Preferences_verify_existing_ids\fR(rc_instance_t\ *inst, . const\ char\ *format_name, . const\ char\ **id_list, . int\ id_list_count, . char\ ***result, . int\ *result_cnt, . webuiprefs_PreferencesError_t\ **error); .RS .RE .fi .SS "Enumerated Types" .PP \fBenum ERROR_TYPE\fR .\" blockquote { .RS 4 .PP .nf typedef enum webuiprefs_ERROR_TYPE { WERRORTYPE_RUNTIME_ERROR = 0, WERRORTYPE_PARSING_ERROR = 1, WERRORTYPE_INVALID_VALUE = 2, WERRORTYPE_INSUFFICIENT_ARGUMENTS = 3, WERRORTYPE_INSUFFICIENT_AUTHORIZATION = 4, } webuiprefs_ERROR_TYPE_t; .fi .RE .\" } blockquote .SS "Structured Types" .PP \fBstruct PreferencesError\fR .\" blockquote { .RS 4 .PP typedef struct webuiprefs_PreferencesError webuiprefs_PreferencesError_t; .PP .nf struct webuiprefs_PreferencesError { webuiprefs_ERROR_TYPE_t wpe_error_type; char *wpe_reason; }; .fi .nf .HP \w'void\ \fBwebuiprefs_PreferencesError_free\fR('u .R void \fBwebuiprefs_PreferencesError_free\fR(webuiprefs_PreferencesError_t\ *in); .RS .RE .fi .RE .\" } blockquote .PP \fBstruct FileImportError\fR .\" blockquote { .RS 4 .PP typedef struct webuiprefs_FileImportError webuiprefs_FileImportError_t; .PP .nf struct webuiprefs_FileImportError { char *wfie_file_path; char *wfie_errors; }; .fi .nf .HP \w'void\ \fBwebuiprefs_FileImportError_free\fR('u .R void \fBwebuiprefs_FileImportError_free\fR(webuiprefs_FileImportError_t\ *in); .RS .RE .fi .RE .\" } blockquote .PP \fBstruct FormatSummary\fR .\" blockquote { .RS 4 .PP typedef struct webuiprefs_FormatSummary webuiprefs_FormatSummary_t; .PP .nf struct webuiprefs_FormatSummary { char *wfs_format; char **wfs_imported_files; int wfs_imported_files_count; webuiprefs_FileImportError_t **wfs_failed_files; int wfs_failed_files_count; webuiprefs_FileImportError_t **wfs_missing_files; int wfs_missing_files_count; char **wfs_skipped_files; int wfs_skipped_files_count; char *wfs_errors; }; .fi .nf .HP \w'void\ \fBwebuiprefs_FormatSummary_free\fR('u .R void \fBwebuiprefs_FormatSummary_free\fR(webuiprefs_FormatSummary_t\ *in); .RS .RE .fi .RE .\" } blockquote .PP \fBstruct ImportSummary\fR .\" blockquote { .RS 4 .PP typedef struct webuiprefs_ImportSummary webuiprefs_ImportSummary_t; .PP .nf struct webuiprefs_ImportSummary { int wis_num_found_files; int wis_num_imported_files; int wis_num_failed_files; int wis_num_missing_files; int wis_num_skipped_files; webuiprefs_FormatSummary_t **wis_format_summaries; int wis_format_summaries_count; char *wis_errors; }; .fi .nf .HP \w'void\ \fBwebuiprefs_ImportSummary_free\fR('u .R void \fBwebuiprefs_ImportSummary_free\fR(webuiprefs_ImportSummary_t\ *in); .RS .RE .fi .RE .\" } blockquote .PP \fBstruct ExportableIds\fR .\" blockquote { .RS 4 .PP typedef struct webuiprefs_ExportableIds webuiprefs_ExportableIds_t; .PP .nf struct webuiprefs_ExportableIds { char *wei_identifier; char *wei_format_module; char *wei_id_type; char *wei_description; webuiprefs_ExportableIds_t **wei_contains; int wei_contains_count; }; .fi .nf .HP \w'void\ \fBwebuiprefs_ExportableIds_free\fR('u .R void \fBwebuiprefs_ExportableIds_free\fR(webuiprefs_ExportableIds_t\ *in); .RS .RE .fi .RE .\" } blockquote .SH "DESCRIPTION" .PP \fBAPI com\&.oracle\&.solaris\&.rad\&.webuiprefs \fR\fB\&\s-2\u[1]\d\s+2\fR .SH "INTERFACES" .SS "interface Preferences" .PP Singleton preferences object .sp .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br .ps +1 \fBPreferences Properties\fR .RS 4 .PP \fB\fIconst char *\fR\fR\ \&\fBapps\fR (\fIread\-only\fR, \fInullable\fR) .\" blockquote { .RS 4 .PP Information about the applications that the user has access to\&. The output is a JSON object in the format: { app_url_base: <app URL base> (e\&.g\&. bui) apps: { "app_1": { schema: [<JSON Schemas]\&.\&.\&. }, "app_2": { schema: [<JSON Schemas]\&.\&.\&. } \&.\&.\&. } "global_schema": [<JSON Schema files>] } .RE .\" } blockquote .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBwebuiprefs_Preferences_get_apps\fR('u .R rc_err_t \fBwebuiprefs_Preferences_get_apps\fR(rc_instance_t\ *inst, . char\ **result, . webuiprefs_PreferencesError_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Get property value\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIresult\fR \(em Property value returned .PP \fIerror\fR .RE .\" } blockquote .RE .\" } blockquote .\" blockquote { .RS 4 .PP \fBRead Error:\fR \fB\fIwebuiprefs_PreferencesError_t **\fR\fR .RE .\" } blockquote .PP \fB\fIconst char *\fR\fR\ \&\fBsystem\fR (\fIread\-only\fR, \fInullable\fR) \(em The system preferences, in JSON format\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBwebuiprefs_Preferences_get_system\fR('u .R rc_err_t \fBwebuiprefs_Preferences_get_system\fR(rc_instance_t\ *inst, . char\ **result, . webuiprefs_PreferencesError_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Get property value\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIresult\fR \(em Property value returned .PP \fIerror\fR .RE .\" } blockquote .RE .\" } blockquote .\" blockquote { .RS 4 .PP \fBRead Error:\fR \fB\fIwebuiprefs_PreferencesError_t **\fR\fR .RE .\" } blockquote .PP \fB\fIconst char *\fR\fR\ \&\fBuser\fR (\fIread\-write\fR, \fInullable\fR) \(em The authorized user\'s own preferences in JSON format, which is modifiable\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBwebuiprefs_Preferences_get_user\fR('u .R rc_err_t \fBwebuiprefs_Preferences_get_user\fR(rc_instance_t\ *inst, . char\ **result, . webuiprefs_PreferencesError_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Get property value\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIresult\fR \(em Property value returned .PP \fIerror\fR .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBwebuiprefs_Preferences_set_user\fR('u .R rc_err_t \fBwebuiprefs_Preferences_set_user\fR(rc_instance_t\ *inst, . const\ char\ *user, . webuiprefs_PreferencesError_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Set property value\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIuser\fR \(em Property value written .PP \fIerror\fR .RE .\" } blockquote .RE .\" } blockquote .\" blockquote { .RS 4 .PP \fBRead\-Write Error:\fR \fB\fIwebuiprefs_PreferencesError_t **\fR\fR .RE .\" } blockquote .PP \fB\fIconst char **\fR\fR\ \&\fBimport_formats\fR (\fIread\-only\fR, \fInullable\fR) .\" blockquote { .RS 4 .PP Get a list of import formats available .RE .\" } blockquote .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBwebuiprefs_Preferences_get_import_formats\fR('u .R rc_err_t \fBwebuiprefs_Preferences_get_import_formats\fR(rc_instance_t\ *inst, . char\ ***result, . int\ *result_cnt, . webuiprefs_PreferencesError_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Get property value\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIresult\fR \(em Property value returned .PP \fIresult_cnt\fR \(em Number of items in result array .PP \fIerror\fR .RE .\" } blockquote .RE .\" } blockquote .\" blockquote { .RS 4 .PP \fBRead Error:\fR \fB\fIwebuiprefs_PreferencesError_t **\fR\fR .RE .\" } blockquote .RE .sp .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br .ps +1 \fBPreferences Methods\fR .RS 4 .nf .HP \w'rc_err_t\ \fBwebuiprefs_Preferences_initialize\fR('u .R rc_err_t \fBwebuiprefs_Preferences_initialize\fR(rc_instance_t\ *inst, . const\ char\ *base_dir, . const\ char\ *username, . webuiprefs_PreferencesError_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Initialize the module, optional\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIbase_dir\fR (\fInullable\fR) .PP \fIusername\fR (\fInullable\fR) .PP \fIerror\fR .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBwebuiprefs_Preferences_validate_json\fR('u .R rc_err_t \fBwebuiprefs_Preferences_validate_json\fR(rc_instance_t\ *inst, . const\ char\ *json_string, . boolean_t\ *is_schema, . const\ char\ *import_format, . char\ **result); .RS .RE .fi .\" blockquote { .RS 4 .PP Validate the supplied JSON string\&. .PP If is_schema is provided it will validate the JSON string as a new JSON Schema, against the currently used JSON Standard\&. .PP If import_format is provided it will validate the JSON string against the specified import format (e\&.g\&. \'analytics\')\&. Otherwise, unless is_schema is true, it will be validated against the preferences own JSON Schema\&. .PP Returns None if there are no errors, otherwise a string containing the available error messages\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIjson_string\fR .PP \fIis_schema\fR (\fInullable\fR) .PP \fIimport_format\fR (\fInullable\fR) .PP \fIresult\fR .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBwebuiprefs_Preferences_import_files\fR('u .R rc_err_t \fBwebuiprefs_Preferences_import_files\fR(rc_instance_t\ *inst, . const\ char\ *format_name, . const\ char\ **files, . int\ files_count, . webuiprefs_ImportSummary_t\ **result, . webuiprefs_PreferencesError_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Look for files to be imported into the WebUI Preferences configuration\&. .PP The directories searched will depend on each import module\&. .PP Optionally, you may specify the format name for the files to be imported\&. .PP Returns an ImportSummary structure with details of the actions performed\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIformat_name\fR (\fInullable\fR) .PP \fIfiles\fR (\fInullable\fR) .PP \fIfiles_count\fR \(em Number of items in files array .PP \fIresult\fR .PP \fIerror\fR .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBwebuiprefs_Preferences_import_string\fR('u .R rc_err_t \fBwebuiprefs_Preferences_import_string\fR(rc_instance_t\ *inst, . const\ char\ *format_name, . const\ char\ *json_string, . char\ **result, . webuiprefs_PreferencesError_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Import the provided JSON string in the specified import format name\&. .PP Returns the converted preferences .PP If there are errors found when performing the import, then a PreferencesError will be raised .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIformat_name\fR (\fInullable\fR) .PP \fIjson_string\fR (\fInullable\fR) .PP \fIresult\fR .PP \fIerror\fR .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBwebuiprefs_Preferences_export_string\fR('u .R rc_err_t \fBwebuiprefs_Preferences_export_string\fR(rc_instance_t\ *inst, . const\ char\ *format_name, . const\ char\ *json_string, . char\ **result, . webuiprefs_PreferencesError_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Export the provided JSON string in the specified export format name\&. .PP Returns the converted preferences .PP If there are errors found when performing the export, then a PreferencesError will be raised .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIformat_name\fR (\fInullable\fR) .PP \fIjson_string\fR (\fInullable\fR) .PP \fIresult\fR .PP \fIerror\fR .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBwebuiprefs_Preferences_export_by_id\fR('u .R rc_err_t \fBwebuiprefs_Preferences_export_by_id\fR(rc_instance_t\ *inst, . const\ char\ *format_name, . const\ char\ **id_list, . int\ id_list_count, . char\ **result, . webuiprefs_PreferencesError_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Export the specified identifiers (UUIDs) to a JSON string in the specified export format name\&. .PP Returns the converted preferences .PP If there are errors found when performing the export, then a PreferencesError will be raised .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIformat_name\fR .PP \fIid_list\fR .PP \fIid_list_count\fR \(em Number of items in id_list array .PP \fIresult\fR .PP \fIerror\fR .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBwebuiprefs_Preferences_get_exportable_ids\fR('u .R rc_err_t \fBwebuiprefs_Preferences_get_exportable_ids\fR(rc_instance_t\ *inst, . const\ char\ *format_name, . webuiprefs_ExportableIds_t\ ***result, . int\ *result_cnt, . webuiprefs_PreferencesError_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Get property value\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIformat_name\fR (\fInullable\fR) \(em Property value returned .PP \fIresult\fR .PP \fIresult_cnt\fR \(em Number of items in result array .PP \fIerror\fR .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBwebuiprefs_Preferences_verify_existing_ids\fR('u .R rc_err_t \fBwebuiprefs_Preferences_verify_existing_ids\fR(rc_instance_t\ *inst, . const\ char\ *format_name, . const\ char\ **id_list, . int\ id_list_count, . char\ ***result, . int\ *result_cnt, . webuiprefs_PreferencesError_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Given a list of identifiers (UUIDs) check if they exist in the specified export format name\&. .PP Returns a list of identifiers that do NOT exist\&. .PP If there are errors found when performing the check, then a PreferencesError will be raised .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIformat_name\fR .PP \fIid_list\fR .PP \fIid_list_count\fR \(em Number of items in id_list array .PP \fIresult\fR .PP \fIresult_cnt\fR \(em Number of items in result array .PP \fIerror\fR .RE .\" } blockquote .RE .sp .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br .ps +1 \fBPreferences Retrieve\fR .RS 4 .nf .HP \w'rc_err_t\ \fBwebuiprefs_Preferences__rad_get_name\fR('u .R rc_err_t \fBwebuiprefs_Preferences__rad_get_name\fR(adr_name_t\ **result, . int\ n, . \&.\&.\&.); .RS .RE .fi .\" blockquote { .RS 4 .PP Obtain RAD name of a Preferences object\&. .PP \fBArguments:\fR .PP \fIresult\fR \(em RAD name .PP \fIn\fR \(em Number of key\-value pairs provided as variadic arguments .PP \&.\&.\&. \(em Optional key\-value pairs that compose the primary key .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBwebuiprefs_Preferences__rad_lookup\fR('u .R rc_err_t \fBwebuiprefs_Preferences__rad_lookup\fR(rc_conn_t\ *c, . boolean_t\ strict, . rc_instance_t\ **result, . int\ n, . \&.\&.\&.); .RS .RE .fi .\" blockquote { .RS 4 .PP Lookup a Preferences instance\&. .PP Construct a RAD name for the interface based on the provided key\-value pairs and perform a lookup\&. If successful, instance reference is returned in the result\&. .PP \fBArguments:\fR .PP \fIc\fR \(em RAD connection handle .PP \fIstrict\fR \(em Strict (B_TRUE) or relaxed (B_FALSE) versioning .PP \fIresult\fR \(em RAD instance .PP \fIn\fR \(em Number of key\-value pairs provided as variadic arguments .PP \&.\&.\&. \(em Optional key\-value pairs that compose the primary key .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBwebuiprefs_Preferences__rad_list\fR('u .R rc_err_t \fBwebuiprefs_Preferences__rad_list\fR(rc_conn_t\ *c, . boolean_t\ strict, . adr_pattern_scheme_t\ scheme, . adr_name_t\ ***result, . int\ *result_count, . int\ n, . \&.\&.\&.); .RS .RE .fi .\" blockquote { .RS 4 .PP List RAD names of a available Preferences instances\&. .PP Returns an array and array size of matching object names\&. .PP \fBArguments:\fR .PP \fIc\fR \(em RAD connection handle .PP \fIstrict\fR \(em Strict (B_TRUE) or relaxed (B_FALSE) versioning .PP \fIscheme\fR \(em Apply glob (NS_GLOB) or regex (NS_REGEX) matching .PP \fIresult\fR \(em Array of RAD names .PP \fIresult_count\fR \(em Number of names in result array .PP \fIn\fR \(em Number of key\-value pairs provided as variadic arguments .PP \&.\&.\&. \(em Optional key\-value pairs that compose the primary key .RE .\" } blockquote .RE .SH "ENUMERATED TYPES" .PP \fBenum ERROR_TYPE\fR .\" blockquote { .RS 4 .PP .nf typedef enum webuiprefs_ERROR_TYPE { WERRORTYPE_RUNTIME_ERROR = 0, WERRORTYPE_PARSING_ERROR = 1, WERRORTYPE_INVALID_VALUE = 2, WERRORTYPE_INSUFFICIENT_ARGUMENTS = 3, WERRORTYPE_INSUFFICIENT_AUTHORIZATION = 4, } webuiprefs_ERROR_TYPE_t; .fi .RE .\" } blockquote .\" blockquote { .RS 4 .PP WERRORTYPE_RUNTIME_ERROR (0) .PP WERRORTYPE_PARSING_ERROR (1) .PP WERRORTYPE_INVALID_VALUE (2) .PP WERRORTYPE_INSUFFICIENT_ARGUMENTS (3) .PP WERRORTYPE_INSUFFICIENT_AUTHORIZATION (4) .RE .\" } blockquote .SH "STRUCTURED TYPES" .PP \fBstruct PreferencesError\fR .\" blockquote { .RS 4 .PP typedef struct webuiprefs_PreferencesError webuiprefs_PreferencesError_t; .PP .nf struct webuiprefs_PreferencesError { webuiprefs_ERROR_TYPE_t wpe_error_type; char *wpe_reason; }; .fi .nf .HP \w'void\ \fBwebuiprefs_PreferencesError_free\fR('u .R void \fBwebuiprefs_PreferencesError_free\fR(webuiprefs_PreferencesError_t\ *in); .RS .RE .fi .RE .\" } blockquote .\" blockquote { .RS 4 .PP \fBFields:\fR .PP \fIwpe_error_type\fR .PP \fIwpe_reason\fR .RE .\" } blockquote .PP \fBstruct FileImportError\fR .\" blockquote { .RS 4 .PP typedef struct webuiprefs_FileImportError webuiprefs_FileImportError_t; .PP .nf struct webuiprefs_FileImportError { char *wfie_file_path; char *wfie_errors; }; .fi .nf .HP \w'void\ \fBwebuiprefs_FileImportError_free\fR('u .R void \fBwebuiprefs_FileImportError_free\fR(webuiprefs_FileImportError_t\ *in); .RS .RE .fi .RE .\" } blockquote .\" blockquote { .RS 4 .PP \fBFields:\fR .PP \fIwfie_file_path\fR .PP \fIwfie_errors\fR .RE .\" } blockquote .PP \fBstruct FormatSummary\fR \(em Structure with format, and a list of associated files .\" blockquote { .RS 4 .PP typedef struct webuiprefs_FormatSummary webuiprefs_FormatSummary_t; .PP .nf struct webuiprefs_FormatSummary { char *wfs_format; char **wfs_imported_files; int wfs_imported_files_count; webuiprefs_FileImportError_t **wfs_failed_files; int wfs_failed_files_count; webuiprefs_FileImportError_t **wfs_missing_files; int wfs_missing_files_count; char **wfs_skipped_files; int wfs_skipped_files_count; char *wfs_errors; }; .fi .nf .HP \w'void\ \fBwebuiprefs_FormatSummary_free\fR('u .R void \fBwebuiprefs_FormatSummary_free\fR(webuiprefs_FormatSummary_t\ *in); .RS .RE .fi .RE .\" } blockquote .\" blockquote { .RS 4 .PP \fBFields:\fR .PP \fIwfs_format\fR .PP \fIwfs_imported_files\fR .PP \fIwfs_imported_files_count\fR .PP \fIwfs_failed_files\fR .PP \fIwfs_failed_files_count\fR .PP \fIwfs_missing_files\fR .PP \fIwfs_missing_files_count\fR .PP \fIwfs_skipped_files\fR .PP \fIwfs_skipped_files_count\fR .PP \fIwfs_errors\fR .RE .\" } blockquote .PP \fBstruct ImportSummary\fR \(em Summary of the import that was just performed .\" blockquote { .RS 4 .PP typedef struct webuiprefs_ImportSummary webuiprefs_ImportSummary_t; .PP .nf struct webuiprefs_ImportSummary { int wis_num_found_files; int wis_num_imported_files; int wis_num_failed_files; int wis_num_missing_files; int wis_num_skipped_files; webuiprefs_FormatSummary_t **wis_format_summaries; int wis_format_summaries_count; char *wis_errors; }; .fi .nf .HP \w'void\ \fBwebuiprefs_ImportSummary_free\fR('u .R void \fBwebuiprefs_ImportSummary_free\fR(webuiprefs_ImportSummary_t\ *in); .RS .RE .fi .RE .\" } blockquote .\" blockquote { .RS 4 .PP \fBFields:\fR .PP \fIwis_num_found_files\fR .PP \fIwis_num_imported_files\fR .PP \fIwis_num_failed_files\fR .PP \fIwis_num_missing_files\fR .PP \fIwis_num_skipped_files\fR .PP \fIwis_format_summaries\fR .PP \fIwis_format_summaries_count\fR .PP \fIwis_errors\fR .RE .\" } blockquote .PP \fBstruct ExportableIds\fR .\" blockquote { .RS 4 .PP typedef struct webuiprefs_ExportableIds webuiprefs_ExportableIds_t; .PP .nf struct webuiprefs_ExportableIds { char *wei_identifier; char *wei_format_module; char *wei_id_type; char *wei_description; webuiprefs_ExportableIds_t **wei_contains; int wei_contains_count; }; .fi .nf .HP \w'void\ \fBwebuiprefs_ExportableIds_free\fR('u .R void \fBwebuiprefs_ExportableIds_free\fR(webuiprefs_ExportableIds_t\ *in); .RS .RE .fi .RE .\" } blockquote .\" blockquote { .RS 4 .PP Structure to contain identifiers that are available for export, the format that is possible to export to, as well as as possible useful type\&. .RE .\" } blockquote .\" blockquote { .RS 4 .PP \fBFields:\fR .PP \fIwei_identifier\fR .PP \fIwei_format_module\fR .PP \fIwei_id_type\fR .PP \fIwei_description\fR .PP \fIwei_contains\fR .PP \fIwei_contains_count\fR .RE .\" } blockquote .SH "VERSION" .PP 1\&.0 .SH "ATTRIBUTES" .PP See attributes(7) for descriptions of the following attributes: .TS allbox tab(:); cB cB. T{ ATTRIBUTE TYPE T}:T{ ATTRIBUTE VALUE T} .T& l l l l. T{ Availability T}:T{ system/management/rad/module/rad\-webuiprefs T} T{ Interface Stability T}:T{ Private T} .TE .sp 1 .SH "SEE ALSO" .PP \fBrad\fR(8) .SH "NOTES" .IP " 1." 4 Accessing Python documentation for this module: .sp .RS 4 .nf $ pydoc rad.bindings.com.oracle.solaris.rad.webuiprefs_1 .fi .RE