Chat now with support
Chat with Support

InTrust 11.6.1 - InTrust SDK Reference

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

IIndexManagerFactory

Creates an instance of IIndexManager for a production or idle repository.

Methods

GetRemoteIndexManager

Creates an IIndexManager instance for a production repository.

Syntax

HRESULT GetRemoteIndexManager(
    [in] BSTR pszServerName,
    [in] BSTR pszRepositoryIdentity,
    [out] IIndexManager** ppManager
);

Parameters
Name Type Meaning

pszServerName

BSTR

Name of an InTrust server in the same organization as the repository.

pszRepositoryIdentity BSTR

ID of the production repository that you need.

ppManager IIndexManager**

Index manager for the production repository.

GetLocalIndexManager

Creates an IIndexManager instance for an idle repository.

Syntax

HRESULT GetLocalIndexManager(
    [in] BSTR pszIndexPath,
    [in] BSTR pszRepositoryPath,
    [in] BSTR pszAcount,
    [in] BSTR pszPassword,
    [in] enum modeOpen mode,
    [out, retval] IIndexManager**
);

Parameters
Name Type Meaning
pszIndexPath

BSTR

Path to the index data for the idle repository.

pszRepositoryPath BSTR

Path to the idle repository file structure.

pszAcount BSTR

User name for access to the idle repository.

pszPassword BSTR

Password for access to the idle repository.

mode

enum

MODE_OPEN = 0
MODE_CREATE = 1

 

IIndexManager**

Index manager to use for indexing-related operations.

IInTrustEnvironment

Entry point for access to InTrust organizations, servers and repositories. Whenever you obtain this legacy interface, you should cast it to IInTrustEnvironment3 and use that instead.

Methods

ConnectToServer

Provides access to the specified InTrust server.

Caution: For this operation to succeed, the account you are using must be a member of the AMS Readers local group on the InTrust server you want to connect to.

Alternatively, it can be an InTrust organization administrator. To configure this privilege for the account, do one of the following:

  • In InTrust Deployment Manager, click Manage | Configure Access.
  • In InTrust Manager, open the properties of the root node.
Syntax

HRESULT ConnectToServer(
    [in] BSTR bstrServerBinding,
    [out, retval] IInTrustServer** ppServer
);

Parameters
Name Type Meaning

bstrServerBinding

BSTR

Name of the InTrust server.

 

IInTrustServer**

InTrust server interface.

Organizations

Provides a collection of available InTrust organizations.

Syntax

HRESULT Organizations(
    [out, retval] IInTrustOrganizationCollection** ppOrganization
);

Parameter
Name Type Meaning

ppOrganization

IInTrustOrganizationCollection**

Collection of available InTrust organizations.

Eventory

Provides access to the log knowledge database associated with the InTrust organization.

Syntax

HRESULT Eventory(
    [out, retval] IInTrustEventory **ppVal
);

Parameter
Name Type Meaning

ppVal

IInTrustEventory**

Log knowledge database associated with the InTrust organization.

IInTrustEnvironment3

Entry point for access to InTrust organizations, servers and repositories.

Methods

ConnectToServer

Provides access to the specified InTrust server. The credentials of the current user are used for the operation.

Caution: For this operation to succeed, the account you are using must be a member of the AMS Readers local group on the InTrust server you want to connect to.

Alternatively, it can be an InTrust organization administrator. To configure this privilege for the account, do one of the following:

  • In InTrust Deployment Manager, click Manage | Configure Access.
  • In InTrust Manager, open the properties of the root node.
Syntax

HRESULT ConnectToServer(
    [in] BSTR bstrServerBinding,
    [out, retval] IInTrustServer** ppServer
);

Parameters
Name Type Meaning

bstrServerBinding

BSTR

Name of the InTrust server.

 

IInTrustServer**

InTrust server interface.

ConnectToServerLocal

Provides access to the InTrust server running locally.

Syntax

ConnectToServerLocal(
    [out, retval] IInTrustServer** ppServer
);

Parameters
Name Type Meaning

ppServer

IInTrustServer**

Interface for the local InTrust server.

ConnectToServerWithCredentials

Provides access to the specified InTrust server using the specified credentials.

Syntax

HRESULT ConnectToServerWithCredentials(
    [in] BSTR bstrServerBinding,
    [in] BSTR bstrUserName,
    [in] BSTR bstrUserPasword,
    [out, retval] IInTrustServer** ppServer);

Parameters
Name Type Meaning

bstrServerBinding

BSTR

Name of the InTrust server.

bstrUserName

BSTR

User name of the account to use for the operation.

bstrUserPasword

BSTR

Password of the account to use for the operation.

ppServer

IInTrustServer**

Interface for the InTrust server.

Organizations

Provides a collection of available InTrust organizations.

Syntax

HRESULT Organizations(
    [out, retval] IInTrustOrganizationCollection** ppOrganization
);

Parameter
Name Type Meaning

ppOrganization

IInTrustOrganizationCollection**

Collection of available InTrust organizations.

IInTrustEventory

Provides access to the log knowledge base, which contains rules that govern the transformation of log entries into repository and event records.

Methods

Eventory

Returns a string representation of the log knowledge base.

Syntax

HRESULT Eventory(
    [out, retval] BSTR* bstrEventory
);

Parameters
Name Type Meaning

bstrEventory

BSTR*

String representation of the log knowledge base.

Logs

Provides access to the log knowledge base entries through an IInTrustEventoryItemCollection.

Syntax

HRESULT Logs(
    [out, retval] IInTrustEventoryItemCollection** pVal
);

Parameters
Name Type Meaning

pVal

IInTrustEventoryItemCollection**

Log knowledge base entries.

DataSources

HRESULT DataSources(
    [out, retval] IInTrustEventoryItemCollection** pVal
);

Parameters
Name Type Meaning

pVal

IInTrustEventoryItemCollection**

Log knowledge base entries.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating