ISMSearch

Module: SMSearch

Public Classes

	Name
struct	FIndexingStatus
struct	FReplaceArgs
class	FReplaceResult
struct	FReplaceSummary
struct	FSearchArgs
class	FSearchResult
class	FSearchResultFiB
struct	FSearchSummary

Public Functions

	Name
virtual	~ISMSearch()
	DECLARE_DELEGATE_OneParam(FOnSearchUpdated , const FSearchSummary & )
	DECLARE_DELEGATE_OneParam(FOnSearchCompleted , const FSearchSummary & )
	DECLARE_DELEGATE_OneParam(FOnSearchCanceled , const FSearchSummary & )
virtual FDelegateHandle	SearchAsync(const FSearchArgs & InArgs, const FOnSearchCompleted & InOnSearchCompletedDelegate, const FOnSearchUpdated & InOnSearchUpdatedDelegate =FOnSearchUpdated(), const FOnSearchCanceled & InOnSearchCanceledDelegate =FOnSearchCanceled()) =0
virtual void	CancelAsyncSearch(const FDelegateHandle & InDelegateHandle) =0
virtual FReplaceSummary	ReplacePropertyValues(const FReplaceArgs & InReplaceArgs, const FSearchArgs & InSearchArgs) =0
virtual bool	EnableDeferredIndexing(bool bEnable) =0
virtual void	GetIndexingStatus(FIndexingStatus & OutIndexingStatus) =0

Public Functions Documentation

function ~ISMSearch

inline virtual ~ISMSearch()

---

function DECLARE_DELEGATE_OneParam

DECLARE_DELEGATE_OneParam(
    FOnSearchUpdated ,
    const FSearchSummary & 
)

---

function DECLARE_DELEGATE_OneParam

DECLARE_DELEGATE_OneParam(
    FOnSearchCompleted ,
    const FSearchSummary & 
)

---

function DECLARE_DELEGATE_OneParam

DECLARE_DELEGATE_OneParam(
    FOnSearchCanceled ,
    const FSearchSummary & 
)

---

function SearchAsync

virtual FDelegateHandle SearchAsync(
    const FSearchArgs & InArgs,
    const FOnSearchCompleted & InOnSearchCompletedDelegate,
    const FOnSearchUpdated & InOnSearchUpdatedDelegate =FOnSearchUpdated(),
    const FOnSearchCanceled & InOnSearchCanceledDelegate =FOnSearchCanceled()
) =0

Search for strings within exposed properties on a separate thread.

Parameters:

InArgs

Arguments to configure the search.

InOnSearchCompletedDelegate

The delegate to call when the search is complete.

InOnSearchUpdatedDelegate

The delegate to call when a search is updated.

InOnSearchCanceledDelegate

The delegate to call if a search is canceled.

Return: The registered delegate handle. This is only needed if this search needs to be canceled.

---

function CancelAsyncSearch

virtual void CancelAsyncSearch(
    const FDelegateHandle & InDelegateHandle
) =0

Cancel an active async search.

Parameters:

InDelegateHandle

The handle for OnSearchCompletedDelegate.

---

function ReplacePropertyValues

virtual FReplaceSummary ReplacePropertyValues(
    const FReplaceArgs & InReplaceArgs,
    const FSearchArgs & InSearchArgs
) =0

Replace strings within property values.

Parameters:

InReplaceArgs

The replacement arguments.

InSearchArgs

the original search arguments.

Return: The summary of the replacement which will contain any errors that occurred.

---

function EnableDeferredIndexing

virtual bool EnableDeferredIndexing(
    bool bEnable
) =0

Force recreate the UE indexer with or without deferred indexing support. When deferred indexing is enabled with multi-threading, the UE indexer can become stuck when a BP is recompiled.

Parameters:

bEnable

Enable or disable deferred indexing.

Return: the value deferred indexing is now set to. This may not equal bEnable if the indexer was unable to be restarted.

---

function GetIndexingStatus

virtual void GetIndexingStatus(
    FIndexingStatus & OutIndexingStatus
) =0

Retrieve the current indexing values.

---