SimpleFormElement.getUsage (Method)

Returns zero or more structures, each containing information about a simple form; for example, 2 (Current), 3 (WIP), 4 (Pending Approval), and so on.

Returns:

SimpleForm_GetUsage_Result (rowlimitedquery)

Arguments:

Name	Type	Required	Description
formID	SimpleFormID_0	Required	A simple form's ID. If this is not set, CommonSpot returns information for all simple form instances instead of just one.
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.
wipStatus	ElementUsageWipStatusFilter	Optional. Defaults to 'Current'.	The work In progress status for which CommonSpot retrieves information: 'All', Current', or 'WIP'.
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.

Context:

License Requirements	None
Permission Requirements	ContributorOrServerCode
Deny Context	None
Require Context	None
Author Lock	(not required)
Transaction Logging	Transaction logging is disabled for this method
Customization	Customization is not supported for this method.

Error Codes:

None

Notes:

None