tc/folder.h File Reference
Detailed Description
This header file declares data types and constants to be used by clients of the folder land module of Teamcenter Engineering
Definition in file folder.h.
#include <tc/folder_errors.h>
#include <tc/tc_startup.h>
#include <tccore/workspaceobject.h>
#include <tc/libtc_exports.h>
#include <tc/libtc_undef.h>
Go to the source code of this file.
Typedefs
Enumerations
- enum FL_sort_criteria_e {
FL_fsc_as_ordered,
FL_fsc_by_name,
FL_fsc_by_object,
FL_fsc_by_type,
FL_fsc_by_date_created,
FL_fsc_by_date_modified,
FL_fsc_by_date_released,
FL_fsc_no_order,
FL_fsc_bad
}
- enum FL_sort_order_e { FL_fso_ascending,
FL_fso_descending,
FL_fso_as_ordered,
FL_fso_bad
}
Functions
- TC_API int FL_init_module ()
- TC_API int FL_exit_module ()
- TC_API int FL_create (const char name[WSO_name_size_c+1], const char description[WSO_desc_size_c+1], tag_t *pfolder_tag)
- TC_API int FL_initialize (tag_t folder_tag, const char name[WSO_name_size_c+1], const char description[WSO_desc_size_c+1])
- TC_API int FL_initialize2 (tag_t folder_tag, const char *name, const char *description)
- TC_API int FL_extent (int *num_of_folders, tag_t **ppfolder_tags)
- TC_API int FL_insert (tag_t folder_tag, tag_t workspaceobject_tag, int position)
- TC_API int FL_insert_instances (tag_t folder_tag, int nInstances, tag_t *workspaceobject_tags, int position)
- TC_API int FL_remove (tag_t folder_tag, tag_t workspaceobject_tag)
- TC_API int FL_move (tag_t folder_tag, int old_start_index, int old_end_index, int new_start_index)
- TC_API int FL_copy (tag_t folder_tag, const char new_folder_name[WSO_name_size_c+1], tag_t *new_folder_tag)
- TC_API int FL_copy2 (tag_t folder_tag, const char *new_folder_name, tag_t *new_folder_tag)
- TC_API int FL_ask_references (tag_t folder_tag, FL_sort_criteria_t sort_criteria, int *num_of_references, tag_t **list_of_references)
- TC_API int FL_ask_index (tag_t folder_tag, tag_t workspaceobject_tag, FL_sort_criteria_t sort_criteria, int *ref_index)
- TC_API int FL_set_sort_order (tag_t folder_tag, FL_sort_order_t sort_order)
- TC_API int FL_ask_sort_order (tag_t folder_tag, FL_sort_order_t *sort_order)
- TC_API int FL_set_sort_criteria (tag_t folder_tag, FL_sort_criteria_t sort_criteria)
- TC_API int FL_ask_sort_criteria (tag_t folder_tag, FL_sort_criteria_t *sort_criteria)
- TC_API int FL_ask_size (tag_t folder_tag, int *number_of_entries)
- TC_API int FL_user_update_newstuff_folder (tag_t folder_tag)
