Chat now with support
Chat with Support

InTrust 11.4.2 - InTrust SDK Reference

InTrust SDK Overview Repository Services API Log Knowledge Base API Enumerations Interfaces

IIndexBuilder

Represents the index-building configuration for the repository. Indexing can be performed by an InTrust server or delegated to InTrust agents in a specific site. Offloading indexing to additional agents can help with InTrust server load balancing.

All this interface does is say what is used for building the index for the repository. If the type of builder is SiteIndexBuilder, then you can configure it by casting IIndexBuilder to ISiteIndexBuilder and working with its methods.

Method

Type

Syntax

HRESULT Type(
   [out, retval] enum IndexBuilderType* pType
);

Parameter
Name Type Meaning

pType

enum IndexBuilderType*

What resources are used for index building.

IIndexingSettings

Provides access to the indexing configuration of a repository.

Methods

IndexingServer (getter)

Returns the indexing server for the repository.

Syntax

HRESULT IndexingServer(
    [out, retval] IInTrustServer3** ppIndexingServer
);

Parameter
Name Type Meaning

ppIndexingServer

IInTrustServer3**

Indexing server for the repository.

IndexingServer (setter)

Sets the specified indexing server for the repository.

Syntax

HRESULT IndexingServer(
    [in] IInTrustServer3* pIndexingServer
);

Parameter
Name Type Meaning

pIndexingServer

IInTrustServer3*

Indexing server to set for the repository.

IndexBuilder

Provides access to the index-building configuration for the repository. For details, see IIndexBuilder.

Syntax

HRESULT IndexBuilder(
    [in, defaultvalue(CurrentIndexBuilder)] enum IndexBuilderType,
    [out, retval] IIndexBuilder** pIndexPathType
);

Parameter
Name Type Meaning

 

enum IndexBuilderType

Selects the method's operation mode:

  • Return the currently set index-building configuration
  • Switch to InTrust server indexing
  • Switch to delegated indexing by agents in an InTrust site

pIndexPathType

IIndexBuilder**

Index-building configuration for the repository.

IndexLocation

Returns the location of the index for the repository.

Syntax

HRESULT IndexLocation(
    [in, defaultvalue(CurrentIndexLocation)] enum IndexLocationType,
    [out, retval] IIndexLocation** pIndexPathType
);

Parameter
Name Type Meaning

CurrentIndexLocation

enum IndexLocationType

 

pIndexPathType

IIndexLocation**

Indexing server for the repository.

IsIndexingEnabled (getter)

Indicates whether indexing is enabled for the repository.

Syntax

HRESULT IsIndexingEnabled(
    [out, retval] VARIANT_BOOL* bEnabled
);

Parameter
Name Type Meaning

bEnabled

VARIANT_BOOL*

Whether indexing is enabled for the repository.

IsIndexingEnabled (setter)

Enables or disables indexing for the repository.

Syntax

HRESULT IsIndexingEnabled(
    [in] VARIANT_BOOL bEnabled
);

Parameter
Name Type Meaning

bEnabled

VARIANT_BOOL

Whether to enable or disable indexing for the repository.

IIndexLocation

Represents the location of the index, which can be a folder in the repository share, as by default, or a custom network share.

All this interface does is say whether the index is in the default or a custom location. If it is custom, cast the IIndexLocation instance to ICustomIndexLocation to get or set the path.

Method

Type

Syntax

HRESULT Type(
   [out, retval] enum IndexLocationType* pType)
);

Parameter
Name Type Meaning

pType

enum IndexLocationType*

Where the index is located: default folder or share.

IIndexManager

Provides access to indexing-related operations.

Methods

GetID

Returns the ID of the index manager.

Syntax

HRESULT GetID(
    [out, retval] BSTR*
);

Parameter
Name Type Meaning

 

BSTR*

ID of the index manager.

Shutdown

Shuts down the index manager.

Syntax

HRESULT Shutdown();

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating