MetadataForm.getBindings (Method)

Returns zero or more structures, each containing information requested by this method's argument. If no arguments are set, CommonSpot returns information for all bindings.

Returns:

MetadataForm_GetBindings_Result (query)

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

Field Name Type Description
BindingID ID_0 The ID of the object to which the metadata form is bound. If this value is 0, the form is bound to an ImageFiles or RegisteredURLs object.
BindingName PlainText A binding's name; for example, if the binding is for a subsite, this will be the subsite's full path.
BindingType BindingType The binding's type; for example, 'ExternalURLs', 'ImageFiles', 'PageCategories' 'Subsite', and so on.
FormID MetadataFormID The ID of the metadata form having this binding.
FormName PlainText_NonNull_255 The name of the metadata form having this binding.
LockStatus ImportedObjectLockStatus The status indicates that this metadata form is locked or not.

Arguments:

Name Type Required Description
bindingType BindingTypeFilter Optional. Defaults to 'All'. The target binding's type; for example, 'ExternalURLs', 'ImageFiles', 'PageCategories' 'Subsite', and so on.
bindingName PlainText Optional. Defaults to an empty string. The name of the binding associated with a record. If this is an empty string, it retrieves all bindings of the specified type. If the 'BindingType' is 'ImageFiles' or 'ExternalURLs' this field should be blank.

Context:

License Requirements (none)
Permission Requirements (none)
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