Hallo, dies ist ein Test.

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

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

'\" t .\" Title: odocprovider-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 "ODOCPROVIDER\-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" odocprovider \- API for accessing Solaris Online Docs .SH "SYNOPSIS" .nf #include <rad/client/1/odocprovider\&.h> cc [ flag\&.\&.\&. ] file\&.\&.\&. \fB\-lodocprovider1_client\fR [ library\&.\&.\&. ] .fi .SS "interface ODocProvider" .nf .HP \w'rc_err_t\ \fBodocprovider_ODocProvider_getDocument\fR('u .R rc_err_t \fBodocprovider_ODocProvider_getDocument\fR(rc_instance_t\ *inst, . const\ char\ *href, . boolean_t\ *resolveTargets, . const\ char\ *language, . odocprovider_Document_t\ **result, . odocprovider_Error_t\ **error); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBodocprovider_ODocProvider_resolveTargets\fR('u .R rc_err_t \fBodocprovider_ODocProvider_resolveTargets\fR(rc_instance_t\ *inst, . const\ char\ **hrefs, . int\ hrefs_count, . const\ char\ *language, . odocprovider__rad_dict_string_string_t\ **result, . odocprovider_Error_t\ **error); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBodocprovider_ODocProvider_getTargets\fR('u .R rc_err_t \fBodocprovider_ODocProvider_getTargets\fR(rc_instance_t\ *inst, . const\ char\ *topicGroup, . const\ char\ *navigationGroup, . const\ char\ *lang, . odocprovider_Target_t\ ***result, . int\ *result_cnt, . odocprovider_Error_t\ **error); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBodocprovider_ODocProvider_getTopicGroups\fR('u .R rc_err_t \fBodocprovider_ODocProvider_getTopicGroups\fR(rc_instance_t\ *inst, . boolean_t\ *includeHidden, . const\ char\ *language, . odocprovider__rad_dict_string_string_t\ **result, . odocprovider_Error_t\ **error); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBodocprovider_ODocProvider_search\fR('u .R rc_err_t \fBodocprovider_ODocProvider_search\fR(rc_instance_t\ *inst, . const\ char\ *query, . int\ *limit, . const\ char\ *language, . odocprovider_SearchResult_t\ ***result, . int\ *result_cnt, . odocprovider_Error_t\ **error); .RS .RE .fi .SS "Enumerated Types" .PP \fBenum ErrorType\fR .\" blockquote { .RS 4 .PP .nf typedef enum odocprovider_ErrorType { OET_ERR_DOCUMENT_NOT_FOUND = 0, OET_ERR_INVALID_HREF = 1, OET_ERR_INVALID_LANG = 2, OET_ERR_SEARCH_UNAVAILABLE = 3, OET_ERR_UNABLE_ACCESS_FILES = 4, } odocprovider_ErrorType_t; .fi .RE .\" } blockquote .SS "Structured Types" .PP \fBstruct Error\fR .\" blockquote { .RS 4 .PP typedef struct odocprovider_Error odocprovider_Error_t; .PP .nf struct odocprovider_Error { odocprovider_ErrorType_t oe_errorType; char *oe_message; }; .fi .nf .HP \w'void\ \fBodocprovider_Error_free\fR('u .R void \fBodocprovider_Error_free\fR(odocprovider_Error_t\ *in); .RS .RE .fi .RE .\" } blockquote .PP \fBstruct Document\fR .\" blockquote { .RS 4 .PP typedef struct odocprovider_Document odocprovider_Document_t; .PP .nf struct odocprovider_Document { char *od_content; odocprovider_Target_t *od_target; odocprovider__rad_dict_string_string_t *od_resolvedTargets; }; .fi .nf .HP \w'void\ \fBodocprovider_Document_free\fR('u .R void \fBodocprovider_Document_free\fR(odocprovider_Document_t\ *in); .RS .RE .fi .RE .\" } blockquote .PP \fBstruct Target\fR .\" blockquote { .RS 4 .PP typedef struct odocprovider_Target odocprovider_Target_t; .PP .nf struct odocprovider_Target { char *ot_href; odocprovider_Target_t **ot_targets; int ot_targets_count; char *ot_topicGroup; char *ot_title; char *ot_navigationGroup; char **ot_labels; int ot_labels_count; }; .fi .nf .HP \w'void\ \fBodocprovider_Target_free\fR('u .R void \fBodocprovider_Target_free\fR(odocprovider_Target_t\ *in); .RS .RE .fi .RE .\" } blockquote .PP \fBstruct SearchResult\fR .\" blockquote { .RS 4 .PP typedef struct odocprovider_SearchResult odocprovider_SearchResult_t; .PP .nf struct odocprovider_SearchResult { odocprovider_Target_t *osr_target; double osr_score; }; .fi .nf .HP \w'void\ \fBodocprovider_SearchResult_free\fR('u .R void \fBodocprovider_SearchResult_free\fR(odocprovider_SearchResult_t\ *in); .RS .RE .fi .RE .\" } blockquote .SS "Dictionaries" .PP \fBDictionary { string : string }\fR .\" blockquote { .RS 4 .PP typedef struct base_rad_dict odocprovider__rad_dict_string_string_t; .RE .\" } blockquote .SH "DESCRIPTION" .PP \fBAPI com\&.oracle\&.solaris\&.rad\&.odocprovider \fR\fB\&\s-2\u[1]\d\s+2\fR .PP Solaris Online Docs module utilizes private odoc Python APIs to serve documentation created using odoctool into WebUI application\&. .PP \fBHref\fR. .PP In order to identify documents in Solaris Online Docs we use \fBhref\fR (handle reference) locator which has following form: \fBbundleId:docId#linkId\fR\&. Part \fBlinkId\fR is optional but \fB#\fR should be present all times\&. All occurences of word \fBhref\fR in this document refer to this locator\&. .SH "INTERFACES" .SS "interface ODocProvider" .PP Solaris Online Docs API\&. .PP ODocProvider interface allows client to: .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} Fetch available documents by their known href\&. .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} Resolve one or more hrefs\&. .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} Retrieve all locally available targets\&. .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} Retrieve all locally available topic groups\&. .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} Search locally indexed document content\&. .RE .sp .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br .ps +1 \fBODocProvider Methods\fR .RS 4 .nf .HP \w'rc_err_t\ \fBodocprovider_ODocProvider_getDocument\fR('u .R rc_err_t \fBodocprovider_ODocProvider_getDocument\fR(rc_instance_t\ *inst, . const\ char\ *href, . boolean_t\ *resolveTargets, . const\ char\ *language, . odocprovider_Document_t\ **result, . odocprovider_Error_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Fetch the document identified by href and optionally resolve all targets in its content\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIhref\fR \(em Href of document to retrieve\&. .PP \fIresolveTargets\fR (\fInullable\fR) \(em If \fBtrue\fR then all targets in the retrieved document content will be resolved and resolutions stored in resolvedTargets\&. If \fBnull\fR it defaults to \fBfalse\fR\&. .PP \fIlanguage\fR (\fInullable\fR) \(em Language variant\&. .PP \fIresult\fR .PP \fIerror\fR .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBodocprovider_ODocProvider_resolveTargets\fR('u .R rc_err_t \fBodocprovider_ODocProvider_resolveTargets\fR(rc_instance_t\ *inst, . const\ char\ **hrefs, . int\ hrefs_count, . const\ char\ *language, . odocprovider__rad_dict_string_string_t\ **result, . odocprovider_Error_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Resolves given list of hrefs to a dictionary of either locally or externally available targets\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIhrefs\fR \(em List of URIs to be resolved\&. .PP \fIhrefs_count\fR \(em Number of items in hrefs array .PP \fIlanguage\fR (\fInullable\fR) \(em Language variant\&. If \fBnull\fR it defaults to \fBen\fR\&. .PP \fIresult\fR \(em Dictionary of all resolvable targets based on input parameter hrefs\&. .\" blockquote { .RS 4 .PP Key is target href (same as in argument hrefs) and value is either \'\-\' for locally available targets (which can be fetched just by key) or full URL in case of external targets\&. If target is not resolvable, that key is not in this dictionary list\&. .RE .\" } blockquote .PP \fIerror\fR .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBodocprovider_ODocProvider_getTargets\fR('u .R rc_err_t \fBodocprovider_ODocProvider_getTargets\fR(rc_instance_t\ *inst, . const\ char\ *topicGroup, . const\ char\ *navigationGroup, . const\ char\ *lang, . odocprovider_Target_t\ ***result, . int\ *result_cnt, . odocprovider_Error_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Retrieve all locally available Target structures in a tree\-like recursive form\&. Optionally list only targets that belong to the specified topicGroup or navigationGroup group\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fItopicGroup\fR (\fInullable\fR) \(em Only retrieve Target structures that belong to this topic group\&. If \fBnull\fR results for all available groups will be retrieved\&. .PP \fInavigationGroup\fR (\fInullable\fR) \(em Only retrieve Target structures that belong to this navigation group\&. If \fBnull\fR results for all available groups will be retrieved\&. .PP \fIlang\fR (\fInullable\fR) \(em Language variant\&. If \fBnull\fR it defaults to \fBen\fR\&. .PP \fIresult\fR \(em Recursive list of Target structs\&. .PP \fIresult_cnt\fR \(em Number of items in result array .PP \fIerror\fR .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBodocprovider_ODocProvider_getTopicGroups\fR('u .R rc_err_t \fBodocprovider_ODocProvider_getTopicGroups\fR(rc_instance_t\ *inst, . boolean_t\ *includeHidden, . const\ char\ *language, . odocprovider__rad_dict_string_string_t\ **result, . odocprovider_Error_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Retrieve the list of all topic groups that have at least one document available locally\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIincludeHidden\fR (\fInullable\fR) \(em Include special\-purpose hidden groups that would not otherwise be reported to client applications\&. If \fBnull\fR it defaults to \fBfalse\fR\&. .PP \fIlanguage\fR (\fInullable\fR) \(em Language variant\&. If \fBnull\fR it defaults to \fBen\fR\&. .PP \fIresult\fR \(em Dictionary of available topic groups\&. .PP \fIerror\fR .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBodocprovider_ODocProvider_search\fR('u .R rc_err_t \fBodocprovider_ODocProvider_search\fR(rc_instance_t\ *inst, . const\ char\ *query, . int\ *limit, . const\ char\ *language, . odocprovider_SearchResult_t\ ***result, . int\ *result_cnt, . odocprovider_Error_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Search locally indexed document content\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIquery\fR \(em Plain text query string\&. .PP \fIlimit\fR (\fInullable\fR) \(em Maximum number of results\&. If limit is \fBnull\fR, the default maximum number of results is \fB1\fR\&. .PP \fIlanguage\fR (\fInullable\fR) \(em Language variant\&. If \fBnull\fR it defaults to \fBen\fR\&. .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 \fBODocProvider Retrieve\fR .RS 4 .nf .HP \w'rc_err_t\ \fBodocprovider_ODocProvider__rad_get_name\fR('u .R rc_err_t \fBodocprovider_ODocProvider__rad_get_name\fR(adr_name_t\ **result, . int\ n, . \&.\&.\&.); .RS .RE .fi .\" blockquote { .RS 4 .PP Obtain RAD name of a ODocProvider 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\ \fBodocprovider_ODocProvider__rad_lookup\fR('u .R rc_err_t \fBodocprovider_ODocProvider__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 ODocProvider 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\ \fBodocprovider_ODocProvider__rad_list\fR('u .R rc_err_t \fBodocprovider_ODocProvider__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 ODocProvider 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 ErrorType\fR \(em Enumeration of error types\&. .\" blockquote { .RS 4 .PP .nf typedef enum odocprovider_ErrorType { OET_ERR_DOCUMENT_NOT_FOUND = 0, OET_ERR_INVALID_HREF = 1, OET_ERR_INVALID_LANG = 2, OET_ERR_SEARCH_UNAVAILABLE = 3, OET_ERR_UNABLE_ACCESS_FILES = 4, } odocprovider_ErrorType_t; .fi .RE .\" } blockquote .\" blockquote { .RS 4 .PP OET_ERR_DOCUMENT_NOT_FOUND (0) \(em Document not found\&. .PP OET_ERR_INVALID_HREF (1) \(em One or more hrefs are not valid\&. .PP OET_ERR_INVALID_LANG (2) \(em Language variant is not valid\&. .PP OET_ERR_SEARCH_UNAVAILABLE (3) \(em Search service is not available or index is broken\&. .PP OET_ERR_UNABLE_ACCESS_FILES (4) \(em Unable to access requested document files\&. .RE .\" } blockquote .SH "STRUCTURED TYPES" .PP \fBstruct Error\fR \(em Error descriptor\&. .\" blockquote { .RS 4 .PP typedef struct odocprovider_Error odocprovider_Error_t; .PP .nf struct odocprovider_Error { odocprovider_ErrorType_t oe_errorType; char *oe_message; }; .fi .nf .HP \w'void\ \fBodocprovider_Error_free\fR('u .R void \fBodocprovider_Error_free\fR(odocprovider_Error_t\ *in); .RS .RE .fi .RE .\" } blockquote .\" blockquote { .RS 4 .PP \fBFields:\fR .PP \fIoe_errorType\fR .PP \fIoe_message\fR \(em Detailed error message\&. .RE .\" } blockquote .PP \fBstruct Document\fR \(em A container for retrieved document content, Target data, and, optionally, resolved target URIs\&. .\" blockquote { .RS 4 .PP typedef struct odocprovider_Document odocprovider_Document_t; .PP .nf struct odocprovider_Document { char *od_content; odocprovider_Target_t *od_target; odocprovider__rad_dict_string_string_t *od_resolvedTargets; }; .fi .nf .HP \w'void\ \fBodocprovider_Document_free\fR('u .R void \fBodocprovider_Document_free\fR(odocprovider_Document_t\ *in); .RS .RE .fi .RE .\" } blockquote .\" blockquote { .RS 4 .PP \fBFields:\fR .PP \fIod_content\fR \(em Document content in HTML\&. .PP \fIod_target\fR \(em Target data for document content\&. .PP \fIod_resolvedTargets\fR \(em Dictionary list of all resolvable targets in the document content\&. .\" blockquote { .RS 4 .PP Key is target href and value is either \'\-\' for locally available targets (which can be fetched just by key) or full URL in case of external targets\&. Unresolvable target keys are not present in dictionary\&. .RE .\" } blockquote .RE .\" } blockquote .PP \fBstruct Target\fR \(em Recursive linkable target descriptor\&. .\" blockquote { .RS 4 .PP typedef struct odocprovider_Target odocprovider_Target_t; .PP .nf struct odocprovider_Target { char *ot_href; odocprovider_Target_t **ot_targets; int ot_targets_count; char *ot_topicGroup; char *ot_title; char *ot_navigationGroup; char **ot_labels; int ot_labels_count; }; .fi .nf .HP \w'void\ \fBodocprovider_Target_free\fR('u .R void \fBodocprovider_Target_free\fR(odocprovider_Target_t\ *in); .RS .RE .fi .RE .\" } blockquote .\" blockquote { .RS 4 .PP \fBFields:\fR .PP \fIot_href\fR \(em Target locator string of the form: \fBbundleId:docId#[linkId]\fR\&. .PP \fIot_targets\fR \(em A list of nested target structures\&. .PP \fIot_targets_count\fR .PP \fIot_topicGroup\fR \(em The topic group to which the target belongs\&. .PP \fIot_title\fR \(em Target title\&. .PP \fIot_navigationGroup\fR \(em The navigation group, if any, to which the target belongs\&. This metadata helps client applications build navigation panels, for example\&. .PP \fIot_labels\fR \(em The list of labels to which the target is attached, in the form sort_mode:label\&. This metadata helps client applications organize targets in different ways for navigation purposes\&. .PP \fIot_labels_count\fR .RE .\" } blockquote .PP \fBstruct SearchResult\fR \(em A search result descriptor\&. .\" blockquote { .RS 4 .PP typedef struct odocprovider_SearchResult odocprovider_SearchResult_t; .PP .nf struct odocprovider_SearchResult { odocprovider_Target_t *osr_target; double osr_score; }; .fi .nf .HP \w'void\ \fBodocprovider_SearchResult_free\fR('u .R void \fBodocprovider_SearchResult_free\fR(odocprovider_SearchResult_t\ *in); .RS .RE .fi .RE .\" } blockquote .\" blockquote { .RS 4 .PP \fBFields:\fR .PP \fIosr_target\fR \(em Target data for a matched document\&. .PP \fIosr_score\fR \(em Match score\&. .RE .\" } blockquote .SH "DICTIONARIES" .SS "Dictionary { string : string }" .PP Dictionary with a key type of string and a value type of string\&. .PP typedef struct base_rad_dict odocprovider__rad_dict_string_string_t; .nf .HP \w'rc_err_t\ \fBodocprovider__rad_dict_string_string_get\fR('u .R rc_err_t \fBodocprovider__rad_dict_string_string_get\fR(odocprovider__rad_dict_string_string_t\ *dict, . const\ char\ *key, . char\ **result); .RS .RE .fi .\" blockquote { .RS 4 .PP Get the value for given key\&. .PP \fBArguments:\fR .PP \fIdict\fR \(em Dictionary .PP \fIkey\fR \(em Key value .PP \fIresult\fR \(em Value returned .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBodocprovider__rad_dict_string_string_put\fR('u .R rc_err_t \fBodocprovider__rad_dict_string_string_put\fR(odocprovider__rad_dict_string_string_t\ *dict, . const\ char\ *key, . const\ char\ *value, . char\ **result); .RS .RE .fi .\" blockquote { .RS 4 .PP Put a key\-value pair into the dictionary\&. .PP Returns a previous value stored with the same key if one exists\&. .PP \fBArguments:\fR .PP \fIdict\fR \(em Dictionary .PP \fIkey\fR \(em Key value .PP \fIvalue\fR \(em Value written .PP \fIresult\fR \(em Original value for the key .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBodocprovider__rad_dict_string_string_contains\fR('u .R rc_err_t \fBodocprovider__rad_dict_string_string_contains\fR(odocprovider__rad_dict_string_string_t\ *dict, . const\ char\ *key); .RS .RE .fi .\" blockquote { .RS 4 .PP Check whether a key exists in the dictionary\&. .PP Returns RCE_OK when key exists, RCE_CLIENT_NOTFOUND otherwise\&. .PP \fBArguments:\fR .PP \fIdict\fR \(em Dictionary .PP \fIkey\fR \(em Key value .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBodocprovider__rad_dict_string_string_remove\fR('u .R rc_err_t \fBodocprovider__rad_dict_string_string_remove\fR(odocprovider__rad_dict_string_string_t\ *dict, . const\ char\ *key, . char\ **result); .RS .RE .fi .\" blockquote { .RS 4 .PP Remove key\-value pair from the dictionary\&. .PP Returns RCE_OK when key was sucessfully removed, RCE_CLIENT_NOTFOUND otherwise\&. .PP \fBArguments:\fR .PP \fIdict\fR \(em Dictionary .PP \fIkey\fR \(em Key value .PP \fIresult\fR \(em Original value for the key .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBodocprovider__rad_dict_string_string_keys\fR('u .R rc_err_t \fBodocprovider__rad_dict_string_string_keys\fR(odocprovider__rad_dict_string_string_t\ *dict, . char\ ***result, . int\ *count); .RS .RE .fi .\" blockquote { .RS 4 .PP Get list of keys from the dictionary\&. .PP Memory associated with the result array should be freed by the user\&. .PP \fBArguments:\fR .PP \fIdict\fR \(em Dictionary .PP \fIresult\fR \(em Array of dictionary keys .PP \fIcount\fR \(em Number of items in result array .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBodocprovider__rad_dict_string_string_values\fR('u .R rc_err_t \fBodocprovider__rad_dict_string_string_values\fR(odocprovider__rad_dict_string_string_t\ *dict, . char\ ***result, . int\ *count); .RS .RE .fi .\" blockquote { .RS 4 .PP Get list of values from the dictionary\&. .PP Memory associated with the result array should be freed by the user\&. .PP \fBArguments:\fR .PP \fIdict\fR \(em Dictionary .PP \fIresult\fR \(em Array of dictionary values .PP \fIcount\fR \(em Number of items in result array .RE .\" } blockquote .nf .HP \w'unsigned\ int\ \fBodocprovider__rad_dict_string_string_size\fR('u .R unsigned int \fBodocprovider__rad_dict_string_string_size\fR(odocprovider__rad_dict_string_string_t\ *dict); .RS .RE .fi .\" blockquote { .RS 4 .PP Get number of key\-value pairs in the dictionary\&. .PP \fBArguments:\fR .PP \fIdict\fR \(em Dictionary .RE .\" } blockquote .nf .HP \w'odocprovider__rad_dict_string_string_t\ *\ \fBodocprovider__rad_dict_string_string_create\fR('u .R odocprovider__rad_dict_string_string_t * \fBodocprovider__rad_dict_string_string_create\fR(const\ rc_instance_t\ *inst); .RS .RE .fi .\" blockquote { .RS 4 .PP Create a new, empty dictionary\&. .PP Returns a pointer to the dictionary, or NULL on error\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .RE .\" } blockquote .nf .HP \w'void\ \fBodocprovider__rad_dict_string_string_free\fR('u .R void \fBodocprovider__rad_dict_string_string_free\fR(odocprovider__rad_dict_string_string_t\ *dict); .RS .RE .fi .\" blockquote { .RS 4 .PP Destroy the dictionary and release the allocated memory\&. .PP \fBArguments:\fR .PP \fIdict\fR \(em Dictionary .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBodocprovider__rad_dict_string_string_map\fR('u .R rc_err_t \fBodocprovider__rad_dict_string_string_map\fR(odocprovider__rad_dict_string_string_t\ *dict, . rc_err_t(*func)(const\ char\ *,\ const\ char\ *,\ void\ *), . void\ *arg); .RS .RE .fi .\" blockquote { .RS 4 .PP Invoke a function with each key\-value pair in the dictionary\&. .PP \fBArguments:\fR .PP \fIdict\fR \(em Dictionary .PP \fIfunc\fR \(em Function to invoke .\" blockquote { .RS 4 .PP The arguments are: key, value, user\-data\&. .RE .\" } blockquote .PP \fIarg\fR \(em User data: custom parameter to invoke the function with .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\-odocprovider 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.odocprovider_1 .fi .RE