FileFormats.getList (Method)

Returns zero or more structures, each containing information on a file format; for example, its description and MIME type.

Returns:

FileFormats_GetList_Result (query)

Each row of the returned query results has the following fields:

Field Name	Type	Description
Category	FileFormatType	The category of the file format i.e. Document, Image or Multimedia.
Extension	PlainText_NonNull	The file format's extension; for example, 'cfm'.
FormatDescription	PlainText_NonNull	The file format's description.
IconPath	ServerRelativeURL_EmptyString	A server-relative URL to an icon representing a page or document's type.
ID	FileFormatID	The file format's ID.
IsIndexable	Boolean	Boolean flag which when true indicates that the file format is fully text indexed.
MaxUploadSize	NonNegativeInteger	The maximum upload size in bytes. If this value is 0, no limit exists.
MimeType	PlainText_NonNull	The MIME type associated with this format.
SecurityID	ID_0	The ID of the security record associated with this file format.

Arguments:

Name	Type	Required	Description
id	FileFormatID_0	Optional. Defaults to '0'.	A file format's ID. If this value is 0, CommonSpot returns information for all file formats instead of just one.
type	FileFormatTypeFilter	Optional. Defaults to 'All'.	String identifying a file format's type, either 'Image' or 'Uploaded Document'.
includeUsedOnly	Boolean	Optional. Defaults to '0'.	Boolean flag which when set to true indicates that CommonSpot will only include file formats used in a 'sitepages' result.

Context:

License Requirements	None
Permission Requirements	ContributorOrServerCode
Deny Context	None
Require Context	None
Author Lock

Error Codes:

None

Notes:

None