Used to manage a Classifications object. More...

#include <SketchUpAPI/model/classifications.h>

Related Functions
(Note that these are not member functions.)
enum SUResult	SUClassificationsLoadSchema (SUClassificationsRef classifications, const char *schema_file_name)
	Loads a schema into a classifications object. More...

enum SUResult	SUClassificationsGetSchema (SUClassificationsRef classifications, const char schema_name, SUSchemaRef schema_ref)
	Gets a schema from a classifications object. More...

enum SUResult	SUClassificationsGetNumSchemas (SUClassificationsRef classifications, size_t *num_schemas)
	Gets the number of schemata from a classifications object. More...

enum SUResult	SUClassificationsGetSchemas (SUClassificationsRef classifications, size_t len, SUSchemaRef schemas[], size_t *count)
	Retrieves the schemas in the classifications object. More...

Detailed Description

Used to manage a Classifications object.

Friends And Related Function Documentation

enum SUResult SUClassificationsGetNumSchemas	(	SUClassificationsRef	classifications,
		size_t *	num_schemas
	)

Parameters

[in]	classifications	The classifications object.
[out]	num_schemas	The number of schemas in the classifications object.

Returns

enum SUResult SUClassificationsGetSchema	(	SUClassificationsRef	classifications,
		const char *	schema_name,
		SUSchemaRef *	schema_ref
	)

Parameters

Returns

enum SUResult SUClassificationsGetSchemas	(	SUClassificationsRef	classifications,
		size_t	len,
		SUSchemaRef	schemas[],
		size_t *	count
	)

Parameters

[in]	classifications	The classifications object.
[in]	len	The number of schemas to retrieve.
[out]	schemas	The schemas retrieved.
[out]	count	The number of schemas retrieved.

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if classifications is not a valid object
SU_ERROR_NULL_POINTER_OUTPUT if schemas or count is NULL
SU_ERROR_NO_DATA if len is greater than 0, but no schemas were found in classifications

enum SUResult SUClassificationsLoadSchema	(	SUClassificationsRef	classifications,
		const char *	schema_file_name
	)

Parameters

[in]	classifications	The classificationss object.
[in]	schema_file_name	The full path of the schema to load.

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if classifications is not a valid object
SU_ERROR_INVALID_INPUT if schema_file_name is not a valid path to a schema or is NULL

The documentation for this struct was generated from the following files: