site.h File Reference

#include <sa/sa.h>
#include <sa/libsa_exports.h>
#include <sa/libsa_undef.h>

Go to the source code of this file.

Macros
#define	SITE_default_ods   "ODS_site"
#define	SITE_nonsearchable_sites   "ODS_searchable_sites_excluded"
#define	SITE_permitted_sites   "IDSM_permitted_sites"
#define	SITE_restricted_sites   "IDSM_restricted_sites"
#define	SITE_searchable_sites   "ODS_searchable_sites"
Directory Services Preferences
#define	ODS_permitted_sites   "ODS_permitted_sites"
#define	ODS_restricted_sites   "ODS_restricted_sites"

Functions
SA_API int	SA_ask_site_info (tag_t site_tag, char sitename[SA_site_size_c+1], int *site_id)
SA_API int	SA_ask_site_info2 (tag_t site_tag, char **sitename, int *site_id)
SA_API int	SA_ask_site_info_ex (tag_t site_tag, char sitename[SA_site_size_c+1], int *site_id, logical *external_app)
SA_API int	SA_ask_site_info_ex2 (tag_t site_tag, char **sitename, int *site_id, logical *external_app)
SA_API int	SA_create_site (char sitename[SA_site_size_c+1], int site_id, tag_t *site_tag)
SA_API int	SA_create_site2 (const char *sitename, int site_id, tag_t *site_tag)
SA_API int	SA_extent_site (int *nsites, tag_t **site_tags)
SA_API int	SA_find_site (const char sitename[SA_site_size_c+1], tag_t *site_tag)
SA_API int	SA_find_site2 (const char *sitename, tag_t *site_tag)
SA_API int	SA_find_site_by_id (int site_id, tag_t *site_tag)
SA_API int	SITE_ask_application_type (tag_t siteTag, int *application_type)
SA_API int	SITE_ask_default_ods (int *site_id)
SA_API int	SITE_ask_geography (tag_t site_tag, char geography[SA_geography_size_c+1])
SA_API int	SITE_ask_geography2 (tag_t site_tag, char **geography)
SA_API int	SITE_ask_gms_url (tag_t site_tag, char url[SA_node_size_c+1])
SA_API int	SITE_ask_gms_url2 (tag_t site_tag, char **url)
SA_API int	SITE_ask_http_site (tag_t site_tag, logical *ids_http_site)
SA_API int	SITE_ask_hub_site (tag_t site_tag, logical *is_hub_site)
SA_API int	SITE_ask_master_deletion_allowed (tag_t site_tag, logical *is_master_delete)
SA_API int	SITE_ask_node_name (tag_t site_tag, char nodename[SA_node_size_c+1])
SA_API int	SITE_ask_node_name2 (tag_t site_tag, char **nodename)
SA_API int	SITE_ask_ods_site (tag_t site_tag, logical *is_ods_site)
SA_API int	SITE_ask_ods_url (tag_t site_tag, char url[SA_node_size_c+1])
SA_API int	SITE_ask_ods_url2 (tag_t site_tag, char **url)
SA_API int	SITE_ask_offline_site (tag_t siteTag, logical *is_offline)
SA_API int	SITE_ask_searchable_sites (int *nsites_included, tag_t **sites_included, int *nsites_excluded, tag_t **sites_excluded, int *user_nsites_included, tag_t **user_sites_included, int *user_nsites_excluded, tag_t **user_sites_excluded)
SA_API int	SITE_ask_soa_url (tag_t site_tag, char url[SA_node_size_c+1])
SA_API int	SITE_ask_soa_url2 (tag_t site_tag, char **url)
SA_API int	SITE_ask_tcplmxml_site (tag_t siteTag, logical *is_plmxml)
SA_API int	SITE_ask_unmanaged_site (tag_t siteTag, logical *is_unmanaged)
SA_API int	SITE_is_external_application (tag_t siteTag, logical *is_external)
SA_API int	SITE_set_application_type (tag_t siteTag, int application_type)
SA_API int	SITE_set_geography (tag_t site_tag, const char *geography)
SA_API int	SITE_set_gms_url (tag_t site_tag, const char url[SA_node_size_c+1])
SA_API int	SITE_set_gms_url2 (tag_t site_tag, const char *url)
SA_API int	SITE_set_http_site (tag_t site_tag, logical is_http_site)
SA_API int	SITE_set_hub_site (tag_t site_tag, logical is_hub_site)
SA_API int	SITE_set_master_deletion_allowed (tag_t site_tag, logical is_master_delete)
SA_API int	SITE_set_node_name (tag_t site_tag, const char nodename[SA_node_size_c+1])
SA_API int	SITE_set_node_name2 (tag_t site_tag, const char *nodename)
SA_API int	SITE_set_ods_site (tag_t site_tag, logical is_ods_site)
SA_API int	SITE_set_ods_url (tag_t site_tag, const char url[SA_node_size_c+1])
SA_API int	SITE_set_ods_url2 (tag_t site_tag, const char *url)
SA_API int	SITE_set_offline_site (tag_t siteTag, logical is_offline)
SA_API int	SITE_set_soa_url (tag_t site_tag, const char url[SA_node_size_c+1])
SA_API int	SITE_set_soa_url2 (tag_t site_tag, const char *url)
SA_API int	SITE_set_tcplmxml_site (tag_t siteTag, logical is_plmxml)
SA_API int	SITE_set_unmanaged_site (tag_t siteTag, logical is_unmanaged)

Detailed Description

This header file declares all the functions to be used by clients of the Site class which is part of the System Administration module of Teamcenter Engineering.

Restrictions:

This include file should not generally be used by anyone. Normally sa.h should be included instead.

Definition in file site.h.