Search.getSubsiteSettings (Method)

Returns a structure whose members contain a subsite's search settings.

Returns:

Search_GetSubsiteSettings_Result (struct)

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

Field Name Type Description
DefaultIndexSetting SearchDefaultIndexing A string indicating the default indexing setting: 'automatic', 'disable automatic' or 'disable all'.
SearchCollection PlainText The search collection's name.
SearchCollectionDir PlainText The search collection's directory path.
SubsiteID SubsiteID The subsite's ID.

Arguments:

Name Type Required Description
subsiteIDOrURL SubsiteIDorURL_EmptyString Required The ID of the target subsite, or the server relative path to the target subsite, or an empty string for the current subsite.

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 This method may be customized at the site level

Error Codes:

None

Notes:

None