ITK Function Reference
(V10000.1.0.60_20160308.00)
site.h
Go to the documentation of this file.
1 /*==============================================================================
2 Copyright (c) 2003-2005 UGS Corporation
3 Unpublished - All Rights Reserved
4 ==============================================================================*/
5 
19 /* */
20 
21 #ifndef SITE_H
22 #define SITE_H
23 #include <sa/sa.h>
24 #include <sa/libsa_exports.h>
25 
37 #define SITE_default_ods "ODS_site"
38 
40 #define SITE_permitted_sites "IDSM_permitted_sites"
41 
43 #define SITE_restricted_sites "IDSM_restricted_sites"
44 
46 #define SITE_searchable_sites "ODS_searchable_sites"
47 
49 #define SITE_nonsearchable_sites "ODS_searchable_sites_excluded"
50 
57 #define ODS_permitted_sites "ODS_permitted_sites"
58 
60 #define ODS_restricted_sites "ODS_restricted_sites"
61 
64 #ifdef __cplusplus
65 extern "C"{
66 #endif
67 
74  extern SA_API int SA_extent_site(
75  int* nsites,
76  tag_t** site_tags
77  );
78 
89  extern SA_API int SA_find_site(
90  const char sitename[SA_site_size_c + 1],
91  tag_t* site_tag
92  );
93 
100  extern SA_API int SA_find_site2(
101  const char *sitename,
102  tag_t* site_tag
103  );
104 
110  extern SA_API int SA_find_site_by_id(
111  int site_id,
112  tag_t* site_tag
113  );
114 
121  extern SA_API int SA_ask_site_info(
122  tag_t site_tag,
123  char sitename[SA_site_size_c + 1],
124  int* site_id
125  );
126 
130  extern SA_API int SA_ask_site_info2(
131  tag_t site_tag,
132  char **sitename,
133  int* site_id
134  );
135 
143  extern SA_API int SA_ask_site_info_ex(
144  tag_t site_tag,
145  char sitename[SA_site_size_c + 1],
146  int* site_id,
147  logical* external_app
148  );
149 
153  extern SA_API int SA_ask_site_info_ex2(
154  tag_t site_tag,
155  char **sitename,
156  int* site_id,
157  logical* external_app
158  );
159 
171  extern SA_API int SA_create_site(
172  char sitename[SA_site_size_c + 1],
173  int site_id,
174  tag_t* site_tag
175  );
176 
185  extern SA_API int SA_create_site2(
186  const char *sitename,
187  int site_id,
188  tag_t* site_tag
189  );
190 
197  extern SA_API int SITE_ask_node_name(
198  tag_t site_tag,
199  char nodename[SA_node_size_c + 1]
200  );
201 
205  extern SA_API int SITE_ask_node_name2(
206  tag_t site_tag,
207  char **nodename
208  );
209 
216  extern SA_API int SITE_set_node_name(
217  tag_t site_tag,
218  const char nodename[SA_node_size_c + 1]
220  );
221 
225  extern SA_API int SITE_set_node_name2(
226  tag_t site_tag,
227  const char *nodename
229  );
230 
235  extern SA_API int SITE_ask_ods_site(
236  tag_t site_tag,
237  logical* is_ods_site
238  );
239 
244  extern SA_API int SITE_set_ods_site(
245  tag_t site_tag,
246  logical is_ods_site
248  );
249 
250  extern SA_API int SITE_ask_hub_site(
251  tag_t site_tag,
252  logical* is_hub_site
253  );
254 
255  extern SA_API int SITE_set_hub_site(
256  tag_t site_tag,
257  logical is_hub_site
258  );
259 
260  extern SA_API int SITE_ask_http_site(
261  tag_t site_tag,
262  logical* ids_http_site
263  );
264 
265  extern SA_API int SITE_set_http_site(
266  tag_t site_tag,
267  logical is_http_site
268  );
269 
274  extern SA_API int SITE_ask_ods_url(
275  tag_t site_tag,
276  char url[SA_node_size_c + 1]
277  );
281  extern SA_API int SITE_ask_ods_url2(
282  tag_t site_tag,
283  char **url
284  );
285 
286 
291  extern SA_API int SITE_set_ods_url(
292  tag_t site_tag,
293  const char url[SA_node_size_c + 1]
294  );
295 
298  extern SA_API int SITE_set_ods_url2(
299  tag_t site_tag,
300  const char *url
301  );
302 
307  extern SA_API int SITE_ask_soa_url(
308  tag_t site_tag,
309  char url[SA_node_size_c + 1]
310  );
311 
312  extern SA_API int SITE_ask_soa_url2(
313  tag_t site_tag,
314  char **url
315  );
316 
321  extern SA_API int SITE_set_soa_url(
322  tag_t site_tag,
323  const char url[SA_node_size_c + 1]
324  );
325 
326  extern SA_API int SITE_set_soa_url2(
327  tag_t site_tag,
328  const char *url
329  );
330 
335  extern SA_API int SITE_ask_gms_url(
336  tag_t site_tag,
337  char url[SA_node_size_c + 1]
338  );
339 
340  extern SA_API int SITE_ask_gms_url2(
341  tag_t site_tag,
342  char **url
343  );
344 
345 
350  extern SA_API int SITE_set_gms_url(
351  tag_t site_tag,
352  const char url[SA_node_size_c + 1]
353  );
354 
355  extern SA_API int SITE_set_gms_url2(
356  tag_t site_tag,
357  const char *url
358  );
359 
360  extern SA_API int SITE_ask_tcplmxml_site(
361  tag_t siteTag, /* <I> */
362  logical *is_plmxml /* <O> */
363  );
364 
365  extern SA_API int SITE_set_tcplmxml_site(
366  tag_t siteTag, /* <I> */
367  logical is_plmxml /* <I> */
368  );
369 
370  extern SA_API int SITE_ask_offline_site (
371  tag_t siteTag, /* <I> */
372  logical *is_offline /* <O> */
373  );
374  extern SA_API int SITE_set_offline_site(
375  tag_t siteTag, /* <I> */
376  logical is_offline /* <I> */
377  );
378  extern SA_API int SITE_ask_unmanaged_site (
379  tag_t siteTag,
380  logical *is_unmanaged
381  );
382  extern SA_API int SITE_set_unmanaged_site(
383  tag_t siteTag,
384  logical is_unmanaged
386  );
387 
397  extern SA_API int SITE_ask_master_deletion_allowed (
398  tag_t site_tag,
399  logical *is_master_delete
400  );
401 
411  extern SA_API int SITE_set_master_deletion_allowed(
412  tag_t site_tag,
413  logical is_master_delete
414  );
415 
416  extern SA_API int SITE_ask_application_type(
417  tag_t siteTag, /* <I> */
418  int *application_type /* <O> */
419  );
420  extern SA_API int SITE_set_application_type(
421  tag_t siteTag, /* <I> */
422  int application_type /* <I> */
423  );
424  extern SA_API int SITE_is_external_application(
425  tag_t siteTag, /* <I> */
426  logical *is_external /* <O> */
427  );
428 
429 
436  extern SA_API int SITE_ask_geography(
437  tag_t site_tag,
438  char geography[SA_geography_size_c + 1]
439  );
440 
444  extern SA_API int SITE_ask_geography2(
445  tag_t site_tag,
446  char **geography
447  );
448 
449 
453  extern SA_API int SITE_set_geography(
454  tag_t site_tag,
455  const char * geography
456  );
457 
461  extern SA_API int SITE_ask_default_ods(
462  int* site_id
463  );
464 
465  extern SA_API int SITE_ask_searchable_sites(
466  int* nsites_included,
467  tag_t** sites_included,
468  int* nsites_excluded,
469  tag_t** sites_excluded,
470  int* user_nsites_included,
471  tag_t** user_sites_included,
472  int* user_nsites_excluded,
473  tag_t** user_sites_excluded
474  );
475 
478 #ifdef __cplusplus
479 }
480 #endif
481 
482 #include <sa/libsa_undef.h>
483 
484 #endif