Functions
SA_API int	SA_ask_person_attr (tag_t personTag, const char attributeName[SA_name_size_c+1], char **attributeValue)

SA_API int	SA_ask_person_attr2 (tag_t personTag, const char attributeName, char *attributeValue)

SA_API int	SA_ask_person_attribute (tag_t personTag, const char attributeName[SA_name_size_c+1], char attributeValue[SA_name_size_c+1])

SA_API int	SA_ask_person_attribute2 (tag_t personTag, const char attributeName, char *attributeValue)

SA_API int	SA_ask_person_email_address (tag_t personTag, char **email_address)

SA_API int	SA_ask_person_form_name (tag_t person_tag, char form_name[SA_name_size_c+1])

SA_API int	SA_ask_person_form_name2 (tag_t person_tag, char **form_name)

SA_API int	SA_ask_person_locale (tag_t person_tag, char locale[SA_locale_size_c+1])

SA_API int	SA_ask_person_locale2 (tag_t person_tag, char **locale)

SA_API int	SA_ask_person_name (tag_t person_tag, char person_name[SA_person_name_size_c+1])

SA_API int	SA_ask_person_name2 (tag_t person_tag, char **person_name)

SA_API int	SA_ask_person_timezone (tag_t person_tag, char timezone[SA_timezone_size_c+1])

SA_API int	SA_ask_person_timezone2 (tag_t person_tag, char **timezone)

SA_API int	SA_create_person (const char person_name[SA_person_name_size_c+1], tag_t *person_tag)

SA_API int	SA_create_person2 (const char person_name, tag_t person_tag)

SA_API int	SA_extent_person (int num_of_persons, tag_t *person_tags)

SA_API int	SA_find_person (const char person_name[SA_person_name_size_c+1], tag_t *person_tag)

SA_API int	SA_find_person2 (const char person_name, tag_t person_tag)

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

SA_API int	SA_get_person_data_source (const tag_t person_tag, int *dataSource)

SA_API int	SA_get_person_last_sync_date (const tag_t person_tag, date_t *syncDate)

SA_API int	SA_initialize_person (tag_t person_tag, const char person_name[SA_person_name_size_c+1])

SA_API int	SA_initialize_person2 (tag_t person_tag, const char *person_name)

SA_API int	SA_set_person_attr (tag_t personTag, const char attributeName[SA_name_size_c+1], const char *attributeValue)

SA_API int	SA_set_person_attr2 (tag_t personTag, const char attributeName, const char attributeValue)

SA_API int	SA_set_person_attribute (tag_t personTag, const char attributeName[SA_name_size_c+1], const char attributeValue[SA_name_size_c+1])

SA_API int	SA_set_person_attribute2 (tag_t personTag, const char attributeName, const char attributeValue)

SA_API int	SA_set_person_data_source (const tag_t person_tag, int dataSource)

SA_API int	SA_set_person_form_name (tag_t person_tag, const char form_name[SA_name_size_c+1])

SA_API int	SA_set_person_form_name2 (tag_t person_tag, const char *form_name)

SA_API int	SA_set_person_last_sync_date (const tag_t person_tag, date_t syncDate)

SA_API int	SA_set_person_locale (tag_t person_tag, const char locale[SA_locale_size_c+1])

SA_API int	SA_set_person_locale2 (tag_t person_tag, const char *locale)

SA_API int	SA_set_person_name (tag_t person_tag, const char person_name[SA_person_name_size_c+1])

SA_API int	SA_set_person_name2 (tag_t person_tag, const char *person_name)

SA_API int	SA_set_person_timezone (tag_t person_tag, const char timezone[SA_timezone_size_c+1])

SA_API int	SA_set_person_timezone2 (tag_t person_tag, const char *timezone)

Detailed Description

Function Documentation

SA_API int SA_ask_person_attr	(	tag_t	personTag,
		const char	attributeName[SA_name_size_c+1],
		char **	attributeValue
	)

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

Returns the value of the person attribute for a person. The caller must provide the name of the attribute which can be one of the following: PA1, PA2, ..., PA10. The returned attribute value should be freed.

Parameters

personTag	(I)
attributeName	(I)
attributeValue	(OF)

SA_API int SA_ask_person_attr2	(	tag_t	personTag,
		const char *	attributeName,
		char **	attributeValue
	)

Returns the value of the person attribute for a person. The caller must provide the name of the attribute which can be one of the following: PA1, PA2, ..., PA10. The returned attribute value should be freed.

Parameters

personTag	(I)
attributeName	(I)
attributeValue	(OF)

SA_API int SA_ask_person_attribute	(	tag_t	personTag,
		const char	attributeName[SA_name_size_c+1],
		char	attributeValue[SA_name_size_c+1]
	)

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

Returns the value of the person attribute for a person. The caller must provide the name of the attribute which can be one of the following: PA1, PA2, ..., PA10.

Parameters

personTag	(I)
attributeName	(I)
attributeValue	(O)

SA_API int SA_ask_person_attribute2	(	tag_t	personTag,
		const char *	attributeName,
		char **	attributeValue
	)

Returns the value of the person attribute for a person. The caller must provide the name of the attribute which can be one of the following: PA1, PA2, ..., PA10.

Parameters

personTag	(I)
attributeName	(I)
attributeValue	(OF)

SA_API int SA_ask_person_email_address	(	tag_t	personTag,
		char **	email_address
	)

Returns the email address of the person. If the preference TC_use_tc_alias_in_pa8 is set to ON, the address in the alias/address list will be returned. If the preference TC_use_tc_alias_in_pa8 is set to OFF, the email address stored on the person object will be returned. The returned value should be freed.

Parameters

personTag	(I)
email_address	(OF)

SA_API int SA_ask_person_form_name	(	tag_t	person_tag,
		char	form_name[SA_name_size_c+1]
	)

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

Returns the value of the form name for this person. The form name is the name of the compiled UIL file that contains the form definition.

Parameters

person_tag	(I)
form_name	(O)

SA_API int SA_ask_person_form_name2	(	tag_t	person_tag,
		char **	form_name
	)

Returns the value of the form name for this person. The form name is the name of the compiled UIL file that contains the form definition.

Parameters

person_tag	(I)
form_name	(OF)

SA_API int SA_ask_person_locale	(	tag_t	person_tag,
		char	locale[SA_locale_size_c+1]
	)

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

Returns the value of the locale for this person. The locale is the name of the compiled UIL file that contains the form definition.

Parameters

person_tag	(I)
locale	(O)

SA_API int SA_ask_person_locale2	(	tag_t	person_tag,
		char **	locale
	)

Returns the value of the locale for this person. The locale is the name of the compiled UIL file that contains the form definition.

Parameters

person_tag	(I)
locale	(OF)

SA_API int SA_ask_person_name	(	tag_t	person_tag,
		char	person_name[SA_person_name_size_c+1]
	)

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

Returns the value of the name attribute for a person.

Parameters

person_tag	(I)
person_name	(O)

SA_API int SA_ask_person_name2	(	tag_t	person_tag,
		char **	person_name
	)

Returns the value of the name attribute for a person.

Parameters

person_tag	(I)
person_name	(OF)

SA_API int SA_ask_person_timezone	(	tag_t	person_tag,
		char	timezone[SA_timezone_size_c+1]
	)

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

Returns the value of the timezone for this person. The timezone is the name of the compiled UIL file that contains the form definition.

Parameters

person_tag	(I)
timezone	(O)

SA_API int SA_ask_person_timezone2	(	tag_t	person_tag,
		char **	timezone
	)

Returns the value of the timezone for this person. The timezone is the name of the compiled UIL file that contains the form definition.

Parameters

person_tag	(I)
timezone	(OF)

SA_API int SA_create_person	(	const char	person_name[SA_person_name_size_c+1],
		tag_t *	person_tag
	)

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

Creates a Person object. It is not saved to the database until an explicit call to AOM_save occurs. You must specify a person_name.

Restrictions:

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

Parameters

person_name	(I)
person_tag	(O)

SA_API int SA_create_person2	(	const char *	person_name,
		tag_t *	person_tag
	)

Creates a Person object. It is not saved to the database until an explicit call to AOM_save occurs. You must specify a person_name.

Restrictions:

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

Parameters

person_name	(I)
person_tag	(O)

SA_API int SA_extent_person	(	int *	num_of_persons,
		tag_t **	person_tags
	)

Allocates an array of tags and stores in the array all persons in the database.

The client is responsible for de-allocating the array of person_tags. Use MEM_free to free the memory pointed to by person_tags.

Parameters

num_of_persons	(O) Stores the size of the array
person_tags	(OF) num_of_persons Points to the array of tags

SA_API int SA_find_person	(	const char	person_name[SA_person_name_size_c+1],
		tag_t *	person_tag
	)

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

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

Parameters

person_name	(I)
person_tag	(O)

SA_API int SA_find_person2	(	const char *	person_name,
		tag_t *	person_tag
	)

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

Parameters

person_name	(I)
person_tag	(O)

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

Returns the list of mapped attributes for a person.

Parameters

numberOfAttributes	(O)
list	(OF) numberOfAttributes

SA_API int SA_get_person_data_source	(	const tag_t	person_tag,
		int *	dataSource
	)

Returns the person data source.

Parameters

person_tag	(I)
dataSource	(O)

SA_API int SA_get_person_last_sync_date	(	const tag_t	person_tag,
		date_t *	syncDate
	)

Returns the person last sync date.

Parameters

person_tag	(I)
syncDate	(O)

SA_API int SA_initialize_person	(	tag_t	person_tag,
		const char	person_name[SA_person_name_size_c+1]
	)

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

Initializes a Person object. It is not saved to the database until an explicit call to AOM_save occurs. This function is normally used with a subclass of Person. For example, if a you defined a class special Person, you would first call POM_create_instance to create the object in memory. Then you would use this function to initialize the attributes which were inherited from Person. Finally, you would use additional POM calls to initialize the attributes comprising your specialization of Person.

Parameters

person_tag	(I)
person_name	(I)

SA_API int SA_initialize_person2	(	tag_t	person_tag,
		const char *	person_name
	)

Initializes a Person object. It is not saved to the database until an explicit call to AOM_save occurs. This function is normally used with a subclass of Person. For example, if a you defined a class special Person, you would first call POM_create_instance to create the object in memory. Then you would use this function to initialize the attributes which were inherited from Person. Finally, you would use additional POM calls to initialize the attributes comprising your specialization of Person.

Parameters

person_tag	(I)
person_name	(I)

SA_API int SA_set_person_attr	(	tag_t	personTag,
		const char	attributeName[SA_name_size_c+1],
		const char *	attributeValue
	)

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

Sets attribute of the person. Valid attributes are PA1, PA2, ..., PA10.

Parameters

personTag	(I)
attributeName	(I)
attributeValue	(I)

SA_API int SA_set_person_attr2	(	tag_t	personTag,
		const char *	attributeName,
		const char *	attributeValue
	)

Sets attribute of the person. Valid attributes are PA1, PA2, ..., PA10.

Parameters

personTag	(I)
attributeName	(I)
attributeValue	(I)

SA_API int SA_set_person_attribute	(	tag_t	personTag,
		const char	attributeName[SA_name_size_c+1],
		const char	attributeValue[SA_name_size_c+1]
	)

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

Sets attributes of the person. Valid attributes are PA1, PA2, ..., PA10.

Parameters

personTag	(I)
attributeName	(I)
attributeValue	(I)

SA_API int SA_set_person_attribute2	(	tag_t	personTag,
		const char *	attributeName,
		const char *	attributeValue
	)

Sets attributes of the person. Valid attributes are PA1, PA2, ..., PA10.

Parameters

personTag	(I)
attributeName	(I)
attributeValue	(I)

SA_API int SA_set_person_data_source	(	const tag_t	person_tag,
		int	dataSource
	)

Sets the data source for the person

Parameters

person_tag	(I)
dataSource	(I)

SA_API int SA_set_person_form_name	(	tag_t	person_tag,
		const char	form_name[SA_name_size_c+1]
	)

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

Sets form name attribute of the person. The form name is the name of the compiled UIL file that contains the form definition.

Parameters

person_tag	(I)
form_name	(I)

SA_API int SA_set_person_form_name2	(	tag_t	person_tag,
		const char *	form_name
	)

Sets form name attribute of the person. The form name is the name of the compiled UIL file that contains the form definition.

Parameters

person_tag	(I)
form_name	(I)

SA_API int SA_set_person_last_sync_date	(	const tag_t	person_tag,
		date_t	syncDate
	)

Sets the data source for the person

Parameters

person_tag	(I)
syncDate	(O)

SA_API int SA_set_person_locale	(	tag_t	person_tag,
		const char	locale[SA_locale_size_c+1]
	)

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

Sets locale attribute of the person. The locale is the name of the compiled UIL file that contains the form definition.

Parameters

person_tag	(I)
locale	(I)

SA_API int SA_set_person_locale2	(	tag_t	person_tag,
		const char *	locale
	)

Sets locale attribute of the person. The locale is the name of the compiled UIL file that contains the form definition.

Parameters

person_tag	(I)
locale	(I)

SA_API int SA_set_person_name	(	tag_t	person_tag,
		const char	person_name[SA_person_name_size_c+1]
	)

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

Sets name attribute of the person.

Parameters

person_tag	(I)
person_name	(I)

SA_API int SA_set_person_name2	(	tag_t	person_tag,
		const char *	person_name
	)

Sets name attribute of the person.

Parameters

person_tag	(I)
person_name	(I)

SA_API int SA_set_person_timezone	(	tag_t	person_tag,
		const char	timezone[SA_timezone_size_c+1]
	)

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

Sets timezone attribute of the person. The timezone is the name of the compiled UIL file that contains the form definition.

Parameters

person_tag	(I)
timezone	(I)

SA_API int SA_set_person_timezone2	(	tag_t	person_tag,
		const char *	timezone
	)

Sets timezone attribute of the person. The timezone is the name of the compiled UIL file that contains the form definition.

Parameters

person_tag	(I)
timezone	(I)

Functions

Detailed Description

Function Documentation