Element.getUsageInfo (Method)

Returns zero or more structures, each containing information on each instance of an element type.

Returns:

Element_GetUsageInfo_Result (rowlimitedquery)

Arguments:

Name	Type	Required	Description
elementID	ElementTypeID_0	Required	An element's ID. If this value is 0, CommonSpot returns information for all elements instead of just one.
limit	QueryRowLimit	Optional. Defaults to '#this.LIMIT_TO_SCALABILITY_MAX#'.	An integer specifying one more than the maximum number of rows CommonSpot can return. If this value is 0, it returns all records. If it is -1, CommonSpot can return the number of records specified in the UI scalability setting.
subsiteFilter	SubsiteFilter	Optional. Defaults to '0'.	The subsite's ID. If this value is -1, CommonSpot returns information on the current subsite. If this is 0, CommonSpot returns information for all subsites.
includeChildSubsites	Boolean	Optional. Defaults to '1'.	Boolean flag which when set to true tells CommonSpot to include all of a subsite's children when searching for usage information.
cacheStatus	CacheStatusFilter	Optional. Defaults to 'All'.	The cache's status that CommonSpot should retrieve. This status can be 'All', 'Dynamic', 'Static', or 'Unknown',.
wipStatus	ElementUsageWipStatusFilter	Optional. Defaults to 'Current'.	The work In progress status for which CommonSpot retrieves information: 'All', Current', or 'WIP'.
shareState	CacheShareStateFilter	Optional. Defaults to 'All'.	The cache state for which CommonSpot retrieves information, as follows: 'All', 'Page', 'Subsite', or 'Template'.

Context:

License Requirements	None
Permission Requirements	Contributor
Deny Context	None
Require Context	None
Author Lock	(not required)
Transaction Logging	Transaction logging is disabled for this method
Customization	This method may be customized at the site level

Error Codes:

None

Notes:

None