ContentIterator.EnsureFieldIndexedEx Method (SPList, SPField, 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, _
field As SPField, _
deferIndexCreation As Boolean _
) As Nullable(Of Boolean)
'Usage
Dim list As SPList
Dim field As SPField
Dim deferIndexCreation As Boolean
Dim returnValue As Nullable(Of Boolean)
returnValue = ContentIterator.EnsureFieldIndexedEx(list, _
field, deferIndexCreation)
public static Nullable<bool> EnsureFieldIndexedEx(
SPList list,
SPField field,
bool deferIndexCreation
)
Parameters
- list
Type: Microsoft.SharePoint.SPList
The SPList.
- field
Type: Microsoft.SharePoint.SPField
The SPField.
- 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>
a null reference (Nothing in Visual Basic) if the field was already indexed; true if the field was previously not indexed but has now been indexed; false if the list was previously not indexed and has now been indexed, which is only possible for overloads of this method that defer index creation.
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.