Functions
SA_API int	SA_add_role_to_group (tag_t group_tag, tag_t role_tag)

SA_API int	SA_ask_group_child_groups (tag_t group_tag, logical immediate_only, int n_children, tag_t *children)

SA_API int	SA_ask_group_default_role (tag_t group_tag, tag_t *role_tag)

SA_API int	SA_ask_group_description (tag_t group_tag, char description[SA_description_size_c+1])

SA_API int	SA_ask_group_description2 (tag_t group_tag, char **description)

SA_API int	SA_ask_group_display_name (tag_t group_tag, char **group_display_name)

SA_API int	SA_ask_group_full_name (tag_t group_tag, char **group_full_name)

SA_API int	SA_ask_group_full_name_by_localized_full_name (const char locGroupFullName, char *groupFullName)

SA_API int	SA_ask_group_local_volume_name (tag_t group_tag, char volume_name[SA_volume_name_size_c+1])

SA_API int	SA_ask_group_local_volume_name2 (tag_t group_tag, char **volume_name)

SA_API int	SA_ask_group_localized_full_name (tag_t group_tag, char **group_loc_full_name)

SA_API int	SA_ask_group_name (tag_t group_tag, char groupname[SA_group_name_size_c+1])

SA_API int	SA_ask_group_name2 (tag_t group_tag, char **groupname)

SA_API int	SA_ask_group_nationality (tag_t group_tag, char nationality[SA_nationality_size_c+1])

SA_API int	SA_ask_group_nationality2 (tag_t group_tag, char **nationality)

SA_API int	SA_ask_group_operational_status (tag_t group_tag, int *operational_status)

SA_API int	SA_ask_group_organization_address (tag_t group_tag, char organization_address[SA_organization_address_size_c+1])

SA_API int	SA_ask_group_organization_address2 (tag_t group_tag, char **organization_address)

SA_API int	SA_ask_group_organization_alternate_name (tag_t group_tag, char organization_alternate_name[SA_organization_alternate_name_size_c+1])

SA_API int	SA_ask_group_organization_alternate_name2 (tag_t group_tag, char **organization_alternate_name)

SA_API int	SA_ask_group_organization_id (tag_t group_tag, char organization_id[SA_organization_id_size_c+1])

SA_API int	SA_ask_group_organization_id2 (tag_t group_tag, char **organization_id)

SA_API int	SA_ask_group_organization_legal_name (tag_t group_tag, char organization_legal_name[SA_organization_legal_name_size_c+1])

SA_API int	SA_ask_group_organization_legal_name2 (tag_t group_tag, char **organization_legal_name)

SA_API int	SA_ask_group_organization_name (tag_t group_tag, char organization_name[SA_organization_name_size_c+1])

SA_API int	SA_ask_group_organization_name2 (tag_t group_tag, char **organization_name)

SA_API int	SA_ask_group_organization_type (tag_t group_tag, char organization_type[SA_organization_type_size_c+1])

SA_API int	SA_ask_group_organization_type2 (tag_t group_tag, char **organization_type)

SA_API int	SA_ask_group_organization_url (tag_t group_tag, char organization_url[SA_organization_url_size_c+1])

SA_API int	SA_ask_group_organization_url2 (tag_t group_tag, char **organization_url)

SA_API int	SA_ask_group_parent (tag_t group_tag, tag_t *parent)

SA_API int	SA_ask_group_system_priv (tag_t group_tag, int *privilege)

SA_API int	SA_ask_group_volume_name (tag_t group_tag, char volume_name[SA_volume_name_size_c+1])

SA_API int	SA_ask_group_volume_name2 (tag_t group_tag, char **volume_name)

SA_API int	SA_ask_roles_from_group (tag_t group_tag, int num_of_roles, tag_t *role_tags)

SA_API int	SA_ask_user_default_role_in_group (tag_t user_tag, tag_t group_tag, tag_t *role_tag)

SA_API int	SA_change_group (tag_t group_tag, tag_t role_tag)

SA_API int	SA_create_h_group (const char groupname, int privilege, tag_t parent_group, tag_t group_tag)

SA_API int	SA_extent_group (int num_of_groups, tag_t *group_tags)

SA_API int	SA_extent_group_count (int *num_groups)

SA_API int	SA_find_group (const char groupname, tag_t group_tag)

SA_API int	SA_find_group_by_localized_full_name (const char localizedFullName, tag_t groupTag)

SA_API int	SA_find_groups_by_localized_full_name (const char localizedFullName, int num_groups, tag_t **groupTags)

SA_API int	SA_find_privilege_honored_groups (int num_groups, tag_t *groups)

SA_API int	SA_find_privileged_groups (int num_groups, tag_t *groups)

SA_API int	SA_get_group_data_source (const tag_t group_tag, int *dataSource)

SA_API int	SA_get_group_last_sync_date (const tag_t group_tag, date_t *syncDate)

SA_API int	SA_get_mapped_group_attr_list (int numberOfAttributes, char **list)

SA_API int	SA_initialize_h_group (tag_t group_tag, const char *groupname, int privilege, tag_t parent_group)

SA_API int	SA_list_groups (int num_groups, tag_t group_tags, char **group_names)

SA_API int	SA_list_h_groups (int num_groups, tag_t group_tags, tag_t parent_groups, char **group_names)

SA_API int	SA_remove_role_from_group (tag_t group_tag, tag_t role_tag)

SA_API int	SA_set_group_data_source (const tag_t group_tag, int dataSource)

SA_API int	SA_set_group_default_role (tag_t group_tag, tag_t role_tag)

SA_API int	SA_set_group_description (tag_t group_tag, const char description[SA_description_size_c+1])

SA_API int	SA_set_group_description2 (tag_t group_tag, const char *description)

SA_API int	SA_set_group_last_sync_date (const tag_t group_tag, date_t syncDate)

SA_API int	SA_set_group_local_volume_name (tag_t group_tag, char volume_name[SA_volume_name_size_c+1])

SA_API int	SA_set_group_local_volume_name2 (tag_t group_tag, const char *volume_name)

SA_API int	SA_set_group_name (tag_t group_tag, const char groupname[SA_group_name_size_c+1])

SA_API int	SA_set_group_name2 (tag_t group_tag, const char *groupname)

SA_API int	SA_set_group_nationality (tag_t group_tag, const char nationality[SA_nationality_size_c+1])

SA_API int	SA_set_group_nationality2 (tag_t group_tag, const char *nationality)

SA_API int	SA_set_group_operational_status (tag_t group_tag, int operational_status)

SA_API int	SA_set_group_organization_address (tag_t group_tag, const char organization_address[SA_organization_address_size_c+1])

SA_API int	SA_set_group_organization_address2 (tag_t group_tag, const char *organization_address)

SA_API int	SA_set_group_organization_alternate_name (tag_t group_tag, const char organization_alternate_name[SA_organization_alternate_name_size_c+1])

SA_API int	SA_set_group_organization_alternate_name2 (tag_t group_tag, const char *organization_alternate_name)

SA_API int	SA_set_group_organization_id (tag_t group_tag, const char organization_id[SA_organization_id_size_c+1])

SA_API int	SA_set_group_organization_id2 (tag_t group_tag, const char *organization_id)

SA_API int	SA_set_group_organization_legal_name (tag_t group_tag, const char organization_legal_name[SA_organization_legal_name_size_c+1])

SA_API int	SA_set_group_organization_legal_name2 (tag_t group_tag, const char *organization_legal_name)

SA_API int	SA_set_group_organization_name (tag_t group_tag, const char organization_name[SA_organization_name_size_c+1])

SA_API int	SA_set_group_organization_name2 (tag_t group_tag, const char *organization_name)

SA_API int	SA_set_group_organization_type (tag_t group_tag, const char organization_type[SA_organization_type_size_c+1])

SA_API int	SA_set_group_organization_type2 (tag_t group_tag, const char *organization_type)

SA_API int	SA_set_group_organization_url (tag_t group_tag, const char organization_url[SA_organization_url_size_c+1])

SA_API int	SA_set_group_organization_url2 (tag_t group_tag, const char *organization_url)

SA_API int	SA_set_group_parent (tag_t group_tag, tag_t parent_group)

SA_API int	SA_set_group_system_priv (tag_t group_tag, int privilege)

SA_API int	SA_set_group_volume_name (tag_t group_tag, char volume_name[SA_volume_name_size_c+1])

SA_API int	SA_set_group_volume_name2 (tag_t group_tag, const char *volume_name)

Detailed Description

Function Documentation

SA_API int SA_add_role_to_group	(	tag_t	group_tag,
		tag_t	role_tag
	)

Adds a role to the group.

Restrictions:

You can only access this function when logged in as a system or group administrator.

Parameters

group_tag	(I)
role_tag	(I)

SA_API int SA_ask_group_child_groups	(	tag_t	group_tag,
		logical	immediate_only,
		int *	n_children,
		tag_t **	children
	)

Parameters

group_tag	(I)
immediate_only	(I)
n_children	(O)
children	(OF) n_children

SA_API int SA_ask_group_default_role	(	tag_t	group_tag,
		tag_t *	role_tag
	)

Returns the default role attribute of the group.

When a user is assigned a default group, the user is automatically assigned the default role in that group.

Parameters

group_tag	(I)
role_tag	(O)

SA_API int SA_ask_group_description	(	tag_t	group_tag,
		char	description[SA_description_size_c+1]
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use SA_ask_group_description2

Returns the description attribute for this group.

Parameters

group_tag	(I)
description	(O)

SA_API int SA_ask_group_description2	(	tag_t	group_tag,
		char **	description
	)

Returns the description attribute for this group.

Parameters

group_tag	(I)
description	(OF)

SA_API int SA_ask_group_display_name	(	tag_t	group_tag,
		char **	group_display_name
	)

Parameters

group_tag	(I)
group_display_name	(OF)

SA_API int SA_ask_group_full_name	(	tag_t	group_tag,
		char **	group_full_name
	)

Parameters

group_tag	(I)
group_full_name	(OF)

SA_API int SA_ask_group_full_name_by_localized_full_name	(	const char *	locGroupFullName,
		char **	groupFullName
	)

Parameters

locGroupFullName	(I)
groupFullName	(OF)

SA_API int SA_ask_group_local_volume_name	(	tag_t	group_tag,
		char	volume_name[SA_volume_name_size_c+1]
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use SA_ask_group_local_volume_name2

Returns the default local volume name attribute for the group.

Parameters

group_tag	(I)
volume_name	(O)

SA_API int SA_ask_group_local_volume_name2	(	tag_t	group_tag,
		char **	volume_name
	)

Returns the default local volume name attribute for the group.

Parameters

group_tag	(I)
volume_name	(OF)

SA_API int SA_ask_group_localized_full_name	(	tag_t	group_tag,
		char **	group_loc_full_name
	)

Parameters

group_tag	(I)
group_loc_full_name	(OF)

SA_API int SA_ask_group_name	(	tag_t	group_tag,
		char	groupname[SA_group_name_size_c+1]
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use SA_ask_group_name2

Returns the name attribute for this group.

Parameters

group_tag	(I)
groupname	(O)

SA_API int SA_ask_group_name2	(	tag_t	group_tag,
		char **	groupname
	)

Returns the name attribute for this group.

Parameters

group_tag	(I)
groupname	(OF)

SA_API int SA_ask_group_nationality	(	tag_t	group_tag,
		char	nationality[SA_nationality_size_c+1]
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use SA_ask_group_nationality2

Returns the nationality attribute of the group.

Parameters

group_tag	(I)
nationality	(O)

SA_API int SA_ask_group_nationality2	(	tag_t	group_tag,
		char **	nationality
	)

Returns the nationality attribute of the group.

Parameters

group_tag	(I)
nationality	(OF)

SA_API int SA_ask_group_operational_status	(	tag_t	group_tag,
		int *	operational_status
	)

Returns the operational_status attribute of the group.

Parameters

group_tag	(I)
operational_status	(O)

SA_API int SA_ask_group_organization_address	(	tag_t	group_tag,
		char	organization_address[SA_organization_address_size_c+1]
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use SA_ask_group_organization_address2

Returns the organization_address attribute of the group.

Parameters

group_tag	(I)
organization_address	(O)

SA_API int SA_ask_group_organization_address2	(	tag_t	group_tag,
		char **	organization_address
	)

Returns the organization_address attribute of the group.

Parameters

group_tag	(I)
organization_address	(OF)

SA_API int SA_ask_group_organization_alternate_name	(	tag_t	group_tag,
		char	organization_alternate_name[SA_organization_alternate_name_size_c+1]
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use SA_ask_group_organization_alternate_name2

Returns the organization_alternate_name attribute of the group.

Parameters

group_tag	(I)
organization_alternate_name	(O)

SA_API int SA_ask_group_organization_alternate_name2	(	tag_t	group_tag,
		char **	organization_alternate_name
	)

Returns the organization_alternate_name attribute of the group.

Parameters

group_tag	(I)
organization_alternate_name	(OF)

SA_API int SA_ask_group_organization_id	(	tag_t	group_tag,
		char	organization_id[SA_organization_id_size_c+1]
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use SA_ask_group_organization_id2

Returns the organization_id attribute of the group.

Parameters

group_tag	(I)
organization_id	(O)

SA_API int SA_ask_group_organization_id2	(	tag_t	group_tag,
		char **	organization_id
	)

Returns the organization_id attribute of the group.

Parameters

group_tag	(I)
organization_id	(OF)

SA_API int SA_ask_group_organization_legal_name	(	tag_t	group_tag,
		char	organization_legal_name[SA_organization_legal_name_size_c+1]
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use SA_ask_group_organization_legal_name2

Returns the organization_legal_name attribute of the group.

Parameters

group_tag	(I)
organization_legal_name	(O)

SA_API int SA_ask_group_organization_legal_name2	(	tag_t	group_tag,
		char **	organization_legal_name
	)

Returns the organization_legal_name attribute of the group.

Parameters

group_tag	(I)
organization_legal_name	(OF)

SA_API int SA_ask_group_organization_name	(	tag_t	group_tag,
		char	organization_name[SA_organization_name_size_c+1]
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use SA_ask_group_organization_name2

Returns the organization_name attribute of the group.

Parameters

group_tag	(I)
organization_name	(O)

SA_API int SA_ask_group_organization_name2	(	tag_t	group_tag,
		char **	organization_name
	)

Returns the organization_name attribute of the group.

Parameters

group_tag	(I)
organization_name	(OF)

SA_API int SA_ask_group_organization_type	(	tag_t	group_tag,
		char	organization_type[SA_organization_type_size_c+1]
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use SA_ask_group_organization_type2

Returns the organization_type attribute of the group.

Parameters

group_tag	(I)
organization_type	(O)

SA_API int SA_ask_group_organization_type2	(	tag_t	group_tag,
		char **	organization_type
	)

Returns the organization_type attribute of the group.

Parameters

group_tag	(I)
organization_type	(OF)

SA_API int SA_ask_group_organization_url	(	tag_t	group_tag,
		char	organization_url[SA_organization_url_size_c+1]
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use SA_ask_group_organization_url2

Returns the organization_url attribute of the group.

Parameters

group_tag	(I)
organization_url	(O)

SA_API int SA_ask_group_organization_url2	(	tag_t	group_tag,
		char **	organization_url
	)

Returns the organization_url attribute of the group.

Parameters

group_tag	(I)
organization_url	(OF)

SA_API int SA_ask_group_parent	(	tag_t	group_tag,
		tag_t *	parent
	)

Parameters

group_tag	(I)
parent	(O)

SA_API int SA_ask_group_system_priv	(	tag_t	group_tag,
		int *	privilege
	)

Returns the system privilege attribute of the group. The output values for privilege are:

0 - for user privileges
1 - for system administration privileges

Parameters

group_tag	(I)
privilege	(O)

SA_API int SA_ask_group_volume_name	(	tag_t	group_tag,
		char	volume_name[SA_volume_name_size_c+1]
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use SA_ask_group_volume_name2

Returns the default volume name attribute for the group.

Parameters

group_tag	(I)
volume_name	(O)

SA_API int SA_ask_group_volume_name2	(	tag_t	group_tag,
		char **	volume_name
	)

Returns the default volume name attribute for the group.

Parameters

group_tag	(I)
volume_name	(OF)

SA_API int SA_ask_roles_from_group	(	tag_t	group_tag,
		int *	num_of_roles,
		tag_t **	role_tags
	)

Allocates an array of tags and stores in the array all roles of the specified group. role_tags points to the array of tags. num_of_roles stores the size of the array. The client is responsible for deallocating the array of role_tags. Use MEM_free to free the memory pointed to by role_tags.

Parameters

group_tag	(I)
num_of_roles	(O)
role_tags	(OF) num_of_roles

SA_API int SA_ask_user_default_role_in_group	(	tag_t	user_tag,
		tag_t	group_tag,
		tag_t *	role_tag
	)

This function returns the default role in a group for a specified user.

Parameters

user_tag	(I) Tag of the user to find a role for
group_tag	(I) Group to find the role in
role_tag	(O) Default role tag

SA_API int SA_change_group	(	tag_t	group_tag,
		tag_t	role_tag
	)

Allows the current user to change to a different group and/or role. To change to the default role in a given group, use a role_tag value of NULLTAG.

Parameters

group_tag	(I)
role_tag	(I)

SA_API int SA_create_h_group	(	const char *	groupname,
		int	privilege,
		tag_t	parent_group,
		tag_t *	group_tag
	)

Creates a new group (an instance of the class "Group"). To save it to the database, call AOM_save().

Note: The name is forced to lower case before being set.

Restrictions:

You must be logged in as a Teamcenter Engineering system administrator to use this function.

Return Values:

POM_invalid_value - Invalid privilege, must be 0 or 1.

Parameters

groupname	(I) The new group's name
privilege	(I) The new group's SA privilege (1 if it is an SA group, 0 if not)
parent_group	(I)
group_tag	(O) The new group

SA_API int SA_extent_group	(	int *	num_of_groups,
		tag_t **	group_tags
	)

Allocates an array of tags, and stores in the array all groups in the database. group_tags points to the array of tags. num_of_groups stores the size of the array. The client is responsible for deallocating the array of group_tags. Use MEM_free to free the memory pointed to by group_tags.

Parameters

num_of_groups	(O)
group_tags	(OF) num_of_groups

SA_API int SA_extent_group_count ( int * num_groups )

Parameters

num_groups (O)

SA_API int SA_find_group	(	const char *	groupname,
		tag_t *	group_tag
	)

Finds a group with the specified full name. If an error occurs, then a non-zero integer returns. If no Group exists with the specified name, then a zero returns on the stack and a NULLTAG returns for the group tag.

Parameters

groupname	(I)
group_tag	(O)

SA_API int SA_find_group_by_localized_full_name	(	const char *	localizedFullName,
		tag_t *	groupTag
	)

Parameters

localizedFullName	(I)
groupTag	(O)

SA_API int SA_find_groups_by_localized_full_name	(	const char *	localizedFullName,
		int *	num_groups,
		tag_t **	groupTags
	)

Parameters

localizedFullName	(I)
num_groups	(O)
groupTags	(OF)

SA_API int SA_find_privilege_honored_groups	(	int *	num_groups,
		tag_t **	groups
	)

Finds the groups based on the current user privileges.
If the current user is a system administrator, all existing groups are retrieved including priviled groups.
Otherwise, only the non-privileged groups are retrieved.

Returns

ITK_ok on success
Possibly other POM errors

Parameters

num_groups	(O) The number of groups
groups	(OF) num_groups tags of privilege honored groups

SA_API int SA_find_privileged_groups	(	int *	num_groups,
		tag_t **	groups
	)

Finds privileged groups.

It returns the number of privileged groups and their tags.

Returns

ITK_ok on success
Possibly other POM errors

Parameters

num_groups	(O) The number of groups
groups	(OF) num_groups tags of privileged groups

SA_API int SA_get_group_data_source	(	const tag_t	group_tag,
		int *	dataSource
	)

Returns the group data source.

Parameters

group_tag	(I)
dataSource	(O)

SA_API int SA_get_group_last_sync_date	(	const tag_t	group_tag,
		date_t *	syncDate
	)

Returns the group last sync date.

Parameters

group_tag	(I)
syncDate	(O)

SA_API int SA_get_mapped_group_attr_list	(	int *	numberOfAttributes,
		char ***	list
	)

Returns the list of mapped attributes for a group.

Parameters

numberOfAttributes	(O)
list	(OF) numberOfAttributes

SA_API int SA_initialize_h_group	(	tag_t	group_tag,
		const char *	groupname,
		int	privilege,
		tag_t	parent_group
	)

Initializes a group. To save it to the database, call AOM_save().

Note: The name is forced to lower case before being set.

Restrictions:

You must be logged in as a Teamcenter Engineering system administrator to use this function.

Return Values:

POM_invalid_value - Invalid privilege, must be 0 or 1.

Parameters

group_tag	(I) The group to initialize
groupname	(I) The group's new name
privilege	(I) The group's new SA privilege (1 if it is an SA group, 0 if not)
parent_group	(I)

SA_API int SA_list_groups	(	int *	num_groups,
		tag_t **	group_tags,
		char ***	group_names
	)

Parameters

num_groups	(O) The number of groups
group_tags	(OF) num_groups The group tags
group_names	(OF) num_groups The group names. Please notice that only the group_names array needs to be freed. The individual items within the array itself do NOT

SA_API int SA_list_h_groups	(	int *	num_groups,
		tag_t **	group_tags,
		tag_t **	parent_groups,
		char ***	group_names
	)

Parameters

num_groups	(O) The number of groups
group_tags	(OF) num_groups The group tags
parent_groups	(OF) num_groups Corresponding parent group tags
group_names	(OF) num_groups The group names. Please notice that only the group_names array needs to be freed. The individual items within the array itself do NOT

SA_API int SA_remove_role_from_group	(	tag_t	group_tag,
		tag_t	role_tag
	)

Removes a role from the group.

Restrictions:

You can only access this function when logged in as a system or group administrator.

Parameters

group_tag	(I)
role_tag	(I)

SA_API int SA_set_group_data_source	(	const tag_t	group_tag,
		int	dataSource
	)

Sets the data source for the group

Parameters

group_tag	(I)
dataSource	(I)

SA_API int SA_set_group_default_role	(	tag_t	group_tag,
		tag_t	role_tag
	)

Sets the default role attribute of the group. When a user is assigned a default group, the user is automatically assigned the default role in that group.

Restrictions:

This function can only be accessed when logged in as a system administrator.

Parameters

group_tag	(I)
role_tag	(I)

SA_API int SA_set_group_description	(	tag_t	group_tag,
		const char	description[SA_description_size_c+1]
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use SA_set_group_description2

Sets the description attribute of the group.

Parameters

group_tag	(I)
description	(I)

SA_API int SA_set_group_description2	(	tag_t	group_tag,
		const char *	description
	)

Sets the description attribute of the group.

Parameters

group_tag	(I)
description	(I)

SA_API int SA_set_group_last_sync_date	(	const tag_t	group_tag,
		date_t	syncDate
	)

Sets the data source for the group

Parameters

group_tag	(I)
syncDate	(I)

SA_API int SA_set_group_local_volume_name	(	tag_t	group_tag,
		char	volume_name[SA_volume_name_size_c+1]
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use SA_set_group_local_volume_name2

Sets the default local volume name attribute for the group.

Parameters

group_tag	(I)
volume_name	(I)

SA_API int SA_set_group_local_volume_name2	(	tag_t	group_tag,
		const char *	volume_name
	)

Sets the default local volume name attribute for the group.

Parameters

group_tag	(I)
volume_name	(I)

SA_API int SA_set_group_name	(	tag_t	group_tag,
		const char	groupname[SA_group_name_size_c+1]
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use SA_set_group_name2

Sets the name attribute of the group.

Parameters

group_tag	(I)
groupname	(I)

SA_API int SA_set_group_name2	(	tag_t	group_tag,
		const char *	groupname
	)

Sets the name attribute of the group.

Parameters

group_tag	(I)
groupname	(I)

SA_API int SA_set_group_nationality	(	tag_t	group_tag,
		const char	nationality[SA_nationality_size_c+1]
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use SA_set_group_nationality2

Sets the nationality attribute of the group.

Parameters

group_tag	(I)
nationality	(I)

SA_API int SA_set_group_nationality2	(	tag_t	group_tag,
		const char *	nationality
	)

Sets the nationality attribute of the group.

Parameters

group_tag	(I)
nationality	(I)

SA_API int SA_set_group_operational_status	(	tag_t	group_tag,
		int	operational_status
	)

Sets the operational_status attribute of the group.

Parameters

group_tag	(I)
operational_status	(I)

SA_API int SA_set_group_organization_address	(	tag_t	group_tag,
		const char	organization_address[SA_organization_address_size_c+1]
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use SA_set_group_organization_address2

Sets the organization_address attribute of the group.

Parameters

group_tag	(I)
organization_address	(I)

SA_API int SA_set_group_organization_address2	(	tag_t	group_tag,
		const char *	organization_address
	)

Sets the organization_address attribute of the group.

Parameters

group_tag	(I)
organization_address	(I)

SA_API int SA_set_group_organization_alternate_name	(	tag_t	group_tag,
		const char	organization_alternate_name[SA_organization_alternate_name_size_c+1]
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use SA_set_group_organization_alternate_name2

Sets the organization_alternate_name attribute of the group.

Parameters

group_tag	(I)
organization_alternate_name	(I)

SA_API int SA_set_group_organization_alternate_name2	(	tag_t	group_tag,
		const char *	organization_alternate_name
	)

Sets the organization_alternate_name attribute of the group.

Parameters

group_tag	(I)
organization_alternate_name	(I)

SA_API int SA_set_group_organization_id	(	tag_t	group_tag,
		const char	organization_id[SA_organization_id_size_c+1]
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use SA_set_group_organization_id2

Sets the organization_id attribute of the group.

Parameters

group_tag	(I)
organization_id	(I)

SA_API int SA_set_group_organization_id2	(	tag_t	group_tag,
		const char *	organization_id
	)

Sets the organization_id attribute of the group.

Parameters

group_tag	(I)
organization_id	(I)

SA_API int SA_set_group_organization_legal_name	(	tag_t	group_tag,
		const char	organization_legal_name[SA_organization_legal_name_size_c+1]
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use SA_set_group_organization_legal_name2

Sets the organization_legal_name attribute of the group.

Parameters

group_tag	(I)
organization_legal_name	(I)

SA_API int SA_set_group_organization_legal_name2	(	tag_t	group_tag,
		const char *	organization_legal_name
	)

Sets the organization_legal_name attribute of the group.

Parameters

group_tag	(I)
organization_legal_name	(I)

SA_API int SA_set_group_organization_name	(	tag_t	group_tag,
		const char	organization_name[SA_organization_name_size_c+1]
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use SA_set_group_organization_name2

Sets the organization_name attribute of the group.

Parameters

group_tag	(I)
organization_name	(I)

SA_API int SA_set_group_organization_name2	(	tag_t	group_tag,
		const char *	organization_name
	)

Parameters

group_tag	(I)
organization_name	(I)

SA_API int SA_set_group_organization_type	(	tag_t	group_tag,
		const char	organization_type[SA_organization_type_size_c+1]
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use SA_set_group_organization_type2

Sets the organization_type attribute of the group.

Parameters

group_tag	(I)
organization_type	(I)

SA_API int SA_set_group_organization_type2	(	tag_t	group_tag,
		const char *	organization_type
	)

Sets the organization_type attribute of the group.

Parameters

group_tag	(I)
organization_type	(I)

SA_API int SA_set_group_organization_url	(	tag_t	group_tag,
		const char	organization_url[SA_organization_url_size_c+1]
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use SA_set_group_organization_url2

Sets the organization_url attribute of the group.

Parameters

group_tag	(I)
organization_url	(I)

SA_API int SA_set_group_organization_url2	(	tag_t	group_tag,
		const char *	organization_url
	)

Sets the organization_url attribute of the group.

Parameters

group_tag	(I)
organization_url	(I)

SA_API int SA_set_group_parent	(	tag_t	group_tag,
		tag_t	parent_group
	)

Parameters

group_tag	(I)
parent_group	(I)

SA_API int SA_set_group_system_priv	(	tag_t	group_tag,
		int	privilege
	)

Sets the system privilege attribute of the group. Valid inputs for privilege are:

0 - for user privileges
1 - for system administration privileges

If privilege is set to 1, the group is a system administration group. You must be logged in as a user belonging to a group that has system administration privileges to set privilege to 1. Otherwise, you will receive an error.

Parameters

group_tag	(I)
privilege	(I)

SA_API int SA_set_group_volume_name	(	tag_t	group_tag,
		char	volume_name[SA_volume_name_size_c+1]
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use SA_set_group_volume_name2

Sets the default volume name attribute for the group.

Parameters

group_tag	(I)
volume_name	(I)

SA_API int SA_set_group_volume_name2	(	tag_t	group_tag,
		const char *	volume_name
	)

Sets the default volume name attribute for the group.

Parameters

group_tag	(I)
volume_name	(I)

Functions

Detailed Description

Function Documentation