ContentIterator.EnsureFieldIndexedEx Method (SPList, Guid, Boolean)
Ensures that the SPField object is indexed for a SPList object.
Namespace: Microsoft.Office.Server.Utilities
Assembly: Microsoft.Office.Server (in Microsoft.Office.Server.dll)
Syntax
'Declaration
Public Shared Function EnsureFieldIndexedEx ( _
list As SPList, _
fieldId As Guid, _
deferIndexCreation As Boolean _
) As Nullable(Of Boolean)
'Usage
Dim list As SPList
Dim fieldId As Guid
Dim deferIndexCreation As Boolean
Dim returnValue As Nullable(Of Boolean)
returnValue = ContentIterator.EnsureFieldIndexedEx(list, _
fieldId, deferIndexCreation)
public static Nullable<bool> EnsureFieldIndexedEx(
SPList list,
Guid fieldId,
bool deferIndexCreation
)
Parameters
- list
Type: Microsoft.SharePoint.SPList
The SPList.
- fieldId
Type: System.Guid
A Guid object that represents the field ID.
- deferIndexCreation
Type: System.Boolean
If true, the index will only be created if the SPList is within 20% of the MaxItemsPerThrottledOperation property value. Otherwise, the index will always be created.
Return Value
Type: System.Nullable<Boolean>
Returns Nullable<T>.
Remarks
The deferIndexCreation option is used to defer index creation until a list is large enough. It is useful for indexing text columns, which block changing web collation after creation. Once an index needs to be created, it is far less likely to change the web collation.