SPFeatureCollection.Add method (Guid, Boolean)
啟動一項功能,利用功能定義具有指定之 ID,來建立新的SPFeature物件,然後將它加入至集合,選擇性地強制啟動,即使有錯誤。
Namespace: Microsoft.SharePoint
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Syntax
'宣告
Public Function Add ( _
featureId As Guid, _
force As Boolean _
) As SPFeature
'用途
Dim instance As SPFeatureCollection
Dim featureId As Guid
Dim force As Boolean
Dim returnValue As SPFeature
returnValue = instance.Add(featureId, _
force)
public SPFeature Add(
Guid featureId,
bool force
)
參數
featureId
Type: System.GuidSPFeatureDefinition物件的 [ Id ] 屬性的值。
force
Type: System.Boolean若要強制啟用的功能,即使有錯誤 ; true否則, false。
傳回值
Type: Microsoft.SharePoint.SPFeature
表示功能執行個體的物件。SPFeature物件的 [ FeatureDefinitionScope ] 屬性設定為SPFeatureDefinitionScope.Farm。
Exceptions
Exception | Condition |
---|---|
InvalidOperationException | 功能定義尚未安裝在伺服器陣列,或SPFeatureDefinition物件的 [ Scope ] 屬性的值與集合新增功能的層級不相符。 |
SPFeatureDependencyNotActivatedException | 此功能是取決於另一項功能不在此範圍已啟動。 |
備註
在陣列層級,或在網站集合層級,可以部署功能定義。可以使用Add方法的這個多載,只能與已部署在陣列層級的功能定義。若要啟動功能,使用部署在網站集合層級的功能定義 — 也就是透過沙箱化解決方案提供的功能定義 — 使用Add方法的Add(Guid, Boolean, SPFeatureDefinitionScope)多載。
您可以取得代表安裝在陣列層級的存取SPFarm物件的 [ FeatureDefinitions ] 屬性的功能定義的SPFeatureDefinition物件的集合。在陣列層級集合中的功能定義可以啟動 Web 應用程式、 網站集合或網站 — 只要SPFeatureDefinition物件的Scope屬性符合的集合新增功能的層級。
若要啟動的 Web 應用程式的功能定義,將它加入SPWebApplication物件的Features屬性所傳回的SPFeatureCollection物件。若要啟動它的網站集合,將它加入SPSite物件的Features屬性所傳回的集合。若要啟動它的網站,將它加入SPWeb物件的Features屬性所傳回的集合。如果SPFeatureDefinition物件的 [ Scope ] 屬性的值與集合新增功能的層級不相符,則Add方法會擲回例外狀況InvalidOperationException 。