idcxt.h File Reference

#include <tc/tc_startup.h>
#include <common/emh_const.h>
#include <tccore/idcxt_errors.h>
#include <tccore/libtccore_exports.h>
#include <tccore/libtccore_undef.h>

Go to the source code of this file.

Macros
IDCONTEXT class name and property name constants
#define	IDCONTEXT_class_name_c   "IdContext"
#define	IDCONTEXT_name   "idcxt_name"
#define	IDCONTEXT_description   "idcxt_desc"
IDCONTEXTRULE class name and property constants
#define	IDCONTEXTRULE_class_name_c   "IdContextRule"
#define	IDCONTEXTRULE_idfbl_type   "idfbl_type"
#define	IDCONTEXTRULE_idfr_type   "idfr_type"
#define	IDCONTEXTRULE_idcontext   "idcontext"
#define	IDCONTEXTRULE_rule   "idcxt_rule"

Functions
TCCORE_API int	IDCXT_ask_description (tag_t idcontext_tag, char **description)
TCCORE_API int	IDCXT_ask_name (tag_t idcontext_tag, char **name)
TCCORE_API int	IDCXT_find (const char *name, int *num_idcontexts, tag_t **idcontext_tags)
TCCORE_API int	IDCXT_find_idcontext (const char *name, tag_t *idcontext_tag)
IdContext Rule Functions
Messages Supported By IdContextRule All types of IdContextRule class and its sub-classes support the following messages: TCTYPE_createprops_msg TCTYPE_viewerprops_msg
TCCORE_API int	IDCXT_rule_ask_idcontext (tag_t idcontextrule_tag, tag_t *idcontext_tag)
TCCORE_API int	IDCXT_rule_ask_identifier_type (tag_t idcontextrule_tag, tag_t *identifier_type_tag)
TCCORE_API int	IDCXT_rule_ask_idfbl_type (tag_t idcontextrule_tag, tag_t *identifiable_type_tag)
TCCORE_API int	IDCXT_rule_ask_rule (tag_t idcontextrule_tag, char **rule)
TCCORE_API int	IDCXT_rule_list_altid_rules (int *num_rules, tag_t **idcontext_tags, tag_t **idfbl_type_tags, tag_t **idfr_type_tags, char ***rules)
TCCORE_API int	IDCXT_rule_list_aliasid_rules (int *num_rules, tag_t **idcontext_tags, tag_t **idfr_type_tags)
TCCORE_API int	IDCXT_rule_ui_altid_rules (int *num_rules, tag_t **idcontext_tags, tag_t **idfbl_type_tags, tag_t **idfr_type_tags, char ***rules)
TCCORE_API int	IDCXT_rule_ui_aliasid_rules (int *num_rules, tag_t **idcontext_tags, tag_t **idfr_type_tags)
TCCORE_API int	IDCXT_rule_find_rule (tag_t idcontext_tag, tag_t idfbl_type_tag, tag_t idfr_type_tag, char **rule)
TCCORE_API int	IDCXT_rule_list_altid_contexts (int *num_rules, tag_t **idcontext_tags)

Detailed Description

This file contains the interface to idcontext data manipulation. For other related interfaces for say, archive, backup and change control please review the related topics in the users guide and review the appropriate header files.

Definition in file idcxt.h.

Function Documentation

TCCORE_API int IDCXT_rule_ask_idcontext	(	tag_t	idcontextrule_tag,
		tag_t *	idcontext_tag
	)

Returns the reference to the idcontext object of the idcontextrule.

Parameters

idcontextrule_tag	(I) Tag of existing idcontextrule
idcontext_tag	(O) Tag of idcontext reference to the idcontextrule

TCCORE_API int IDCXT_rule_ask_identifier_type	(	tag_t	idcontextrule_tag,
		tag_t *	identifier_type_tag
	)

Returns the reference to the identifier type object of the idcontextrule.

Parameters

idcontextrule_tag	(I) Tag of existing idcontextrule
identifier_type_tag	(O) Tag of identifier type to the idcontextrule

TCCORE_API int IDCXT_rule_ask_idfbl_type	(	tag_t	idcontextrule_tag,
		tag_t *	identifiable_type_tag
	)

Returns the reference to the identifiable object type of the idcontextrule. When this is NULLTAG, then the rule defines the alias usage.

Parameters

idcontextrule_tag	(I) Tag of existing idcontextrule
identifiable_type_tag	(O) Tag of identifiable type object in the idcontextrule

TCCORE_API int IDCXT_rule_ask_rule	(	tag_t	idcontextrule_tag,
		char **	rule
	)

Returns the rule value for the given idcontextrule.

Parameters

idcontextrule_tag	(I) Tag of existing idcontextrule
rule	(OF) Rule value for the given idcontextrule. Can be null

TCCORE_API int IDCXT_rule_find_rule	(	tag_t	idcontext_tag,
		tag_t	idfbl_type_tag,
		tag_t	idfr_type_tag,
		char **	rule
	)

Returns rule associated with the given combination.

Parameters

idcontext_tag	(I) Idcontext tag
idfbl_type_tag	(I) Identifiable type tag
idfr_type_tag	(I) Identifier type tag
rule	(OF) Rule for the combination above. Can be null.

TCCORE_API int IDCXT_rule_list_aliasid_rules	(	int *	num_rules,
		tag_t **	idcontext_tags,
		tag_t **	idfr_type_tags
	)

Returns all the alias identifier rules in the database. Does not filter out restrictions caused due to hide type restrictions.

Parameters

num_rules	(O) Number of rules
idcontext_tags	(OF) num_rules Array of idcontext tags
idfr_type_tags	(OF) num_rules Array of identifier type tags

TCCORE_API int IDCXT_rule_list_altid_contexts	(	int *	num_rules,
		tag_t **	idcontext_tags
	)

Returns all the Alternate identifier contexts in the database.

Parameters

num_rules	(O) Number of rules
idcontext_tags	(OF) num_rules Array of idcontext tags

TCCORE_API int IDCXT_rule_list_altid_rules	(	int *	num_rules,
		tag_t **	idcontext_tags,
		tag_t **	idfbl_type_tags,
		tag_t **	idfr_type_tags,
		char ***	rules
	)

Returns all the Alternate identifier rules in the database. Does not filter out restrictions caused due to hide type restrictions.

Parameters

num_rules	(O) Number of rules
idcontext_tags	(OF) num_rules Array of idcontext tags
idfbl_type_tags	(OF) num_rules Array of identifiable type tags
idfr_type_tags	(OF) num_rules Array of identifier type tags
rules	(OF) num_rules Array of rules. Some of the elements could be null.

TCCORE_API int IDCXT_rule_ui_aliasid_rules	(	int *	num_rules,
		tag_t **	idcontext_tags,
		tag_t **	idfr_type_tags
	)

Returns all allowed alias identifier rules in the database. It filters out restrictions caused due to hide type configuration.

Parameters

num_rules	(O) Number of rules
idcontext_tags	(OF) num_rules Array of idcontext tags
idfr_type_tags	(OF) num_rules Array of identifier type tags

TCCORE_API int IDCXT_rule_ui_altid_rules	(	int *	num_rules,
		tag_t **	idcontext_tags,
		tag_t **	idfbl_type_tags,
		tag_t **	idfr_type_tags,
		char ***	rules
	)

Returns all allowed Alternate identifier rules in the database. It filters out restrictions caused due to hide type configuration.

Parameters

num_rules	(O) Number of rules
idcontext_tags	(OF) num_rules Array of idcontext tags
idfbl_type_tags	(OF) num_rules Array of identifiable type tags
idfr_type_tags	(OF) num_rules Array of identifier type tags
rules	(OF) num_rules Array of rules. Some of the elements could be null.