adsfoundation.h File Reference

#include <unidefs.h>
#include <adsfoundation/libadsfoundation_exports.h>
#include <adsfoundation/libadsfoundation_undef.h>

Go to the source code of this file.

Macros
#define	ADSFOUNDATION_external_id_size_c   32

Functions
ADSFOUNDATION_API int	ADS_resolve_source_document (const char *object_type, const char *component_id, int num_attributes, const char **attributes_names, const char **attributes_values, const char *source_revision_id, const char *source_owning_organization, logical is_auto_create, tag_t *create_input_for_document, tag_t *autocreate_document, int *num_documents, tag_t **documents)

Macro Definition Documentation

#define ADSFOUNDATION_external_id_size_c   32

Definition at line 29 of file adsfoundation.h.

Function Documentation

ADSFOUNDATION_API int ADS_resolve_source_document	(	const char *	object_type,
		const char *	component_id,
		int	num_attributes,
		const char **	attributes_names,
		const char **	attributes_values,
		const char *	source_revision_id,
		const char *	source_owning_organization,
		logical	is_auto_create,
		tag_t *	create_input_for_document,
		tag_t *	autocreate_document,
		int *	num_documents,
		tag_t **	documents
	)

Searches, auto-selects and auto-creates Source Document objects.

Returns

• ITK_ok on success.
• ADSFOUNDATION_error_InvalidOrgEntry if the value specified in the Source Document Organization field is invalid
• ADSFOUNDATION_error_MismatchOrganizationDuringAutoCreate if the value entered in the Source Document Organization field does not match the user's organization ID
• ADSFOUNDATION_error_Item_does_not_exist if the specified source document does not exist
• ADSFOUNDATION_error_SourceDocumentDoesNotExist if the information about the source document cannot be derived from the given item ID
• ADSFOUNDATION_error_Invalid_Id_For_AutoCreate if the value supplied for property Item Id is invalid for auto-creation
• ADSFOUNDATION_error_EnterSourceDocFields if the auto-creation of source documents is enabled, enter a valid value in the source document field

Parameters

object_type	(I) Type of the component to be created
component_id	(I) Id of the component to be created
num_attributes	(I) Number of Source Document attributes
attributes_names	(I) Names of Source Document attributes
attributes_values	(I) Values of Source Document attributes
source_revision_id	(I) Revision Id of the Source Document
source_owning_organization	(I) Owning Organization of the Source Document Revision
is_auto_create	(I) Source document should be created if not found during search and autocreate is enabled."
create_input_for_document	(O) Tag of the create input object used for the auto-creation of the ADSTechDocument object
autocreate_document	(O) Tag of the auto-created ADSTechDocument object
num_documents	(O) Number of ADSTechDocument objects in output
documents	(OF) num_documents Tags of matching or created ADSTechDocument objects