Chat now with support
Chat con el soporte

InTrust 11.4.1 - InTrust SDK Reference

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

IInTrustOrganizationCollection

Provides a collection of all available InTrust organizations.

Methods

Item

Provides access to the specified InTrust organization.

Syntax

HRESULT Item(
    [in] BSTR bstrOrganizationIdentity,
    [out, retval] IInTrustOrganization**
);

Parameters
Name Type Meaning

bstrOrganizationIdentity

BSTR

Name of the InTrust organization.

 

IInTrustOrganization**

InTrust organization interface.

_NewEnum

Returns an enumerator for the collection.

Syntax

HRESULT _NewEnum(
    [out, retval] LPUNKNOWN* pVal
);

Parameter
Name Type Meaning

pVal

LPUNKNOWN*

Enumerated InTrust organizations.

IInTrustRepository3

Provides the searching and writing capabilities of a repository.

Methods

CustomAttributes

Provides access to the collection (instance of IPropertyCollection) of custom attributes attached to an InTrust repository (instances of IProperty).

Syntax

HRESULT CustomAttributes(
    [out, retval] IPropertyCollection** pVal
);

Parameter
Name Type Meaning

pVal

IPropertyCollection**

Collection of custom attributes attached to the repository.

Description (getter)

Returns the description of the repository.

Syntax

HRESULT Description(
    [out, retval] BSTR* description
);

Parameter
Name Type Meaning

description

BSTR*

Description of the repository.

Description (setter)

Sets the description of the repository.

Syntax

HRESULT Description(
    [in] BSTR description
);

Parameter
Name Type Meaning

description

BSTR

Description of the repository.

ForwardingSettings

Provides access to the forwarding settings for the repository.

Syntax

HRESULT ForwardingSettings(
    [out, retval] IForwardingSettings** ppForwardingSettings
);

Parameter
Name Type Meaning

ppForwardingSettings

IForwardingSettings**

Forwarding settings for the repository.

ID

Returns the GUID of the repository.

Syntax

HRESULT ID(
    [out, retval] GUID* pID

);

Parameter
Name Type Meaning

pID

GUID*

GUID of the repository.

IndexingSettings

Provides access to the indexing settings for the repository.

Syntax

HRESULT IndexingSettings(
    [out, retval] IIndexingSettings** ppIndexingSettings
);

Parameter
Name Type Meaning

ppIndexingSettings

IIndexingSettings**

Indexing settings for the repository.

Inserter

Provides an interface for inserting records into the repository. For details, see Writing Records.

Caution: A new inserter is created every time you call this method. It's likely that you only want a single unique inserter per repository for all of your writing activity.

Syntax

HRESULT Inserter(
    [out, retval] IRepositoryRecordInserter** ppInserter
);

Parameter
Name Type Meaning

ppInserter

IRepositoryRecordInserter**

Record-inserting interface associated with a particular repository.

Name (getter)

Returns the name of the repository.

Syntax

HRESULT Name(
    [out, retval] BSTR* name
);

Parameter
Name Type Meaning

name

BSTR*

Name of the repository. The name is not necessarily unique in an organization.

Name (setter)

Sets the name of the repository.

Syntax

HRESULT Name(
    [in] BSTR name
);

Parameter
Name Type Meaning

name

BSTR

Name of the repository. The name is not necessarily unique in an organization.

Path (getter)

Returns the path to the repository.

Syntax

HRESULT Path(
    [out, retval] BSTR* pVal
);

Parameter
Name Type Meaning

pVal

BSTR*

UNC path to the share that contains the repository.

Path (setter)

Sets the path to the repository.

Syntax

HRESULT Path(
    [in] BSTR path
);

Parameter
Name Type Meaning

path

BSTR

UNC path to the share that contains the repository.

RepositoryAccessCredentials

Provides access to the credentials that are used for access to the repository.

Syntax

HRESULT RepositoryAccessCredentials(
    [in, defaultvalue(CurrentCusomizableCredentials)] enum CustomizableCredentialsType type,
    [out, retval] ICustomizableCredentials** pCredentials
);

Parameters
Name Type Meaning

type

enum CustomizableCredentialsType

How repository access is currently configured.

pCredentials

ICustomizableCredentials**

Credentials that are used for access to the repository.

Searcher

Provides an interface for finding records in the repository. For details, see Getting Records.

Syntax

HRESULT Searcher(
    [out, retval] IInTrustRepositorySearcher** ppSearcher
);

Parameter
Name Type Meaning

ppSearcher

IInTrustRepositorySearcher

A searcher interface that accepts search queries and provides results.

Statuses

Gets the status enumerator for the repository

Syntax

HRESULT Statuses(
    [out, retval] IInTrustRepositoryStatusCollection** pVal
);

Parameter
Name Type Meaning

pVal

IInTrustRepositoryStatusCollection**

Status enumerator for the repository.

IInTrustRepositoryCollection2

Provides a collection of all repositories available in the InTrust organization.

Methods

Item

Gets the specified repository from a collection.

Syntax

HRESULT Item(
    [in] BSTR bstrRepositoryIdentity,
    [out, retval] IInTrustRepository3**
);

Parameters
Name Type Meaning

bstrRepositoryIdentity

BSTR

A piece of information that identifies the repository. You can specify one of the following:

  • Repository name
  • Repository GUID
  • UNC path to the repository share

The Item method tries to interpret its input parameter as each of these identifiers, in that order.

 

IInTrustRepository3**

Repository interface.

Add

Creates a repository with the specified properties in a collection. To configure additional properties, use the methods of the repository that is returned.

Note that even though this makes the repository a member of the collection, it will not actually be created until you have called the Commit method of its IInTrustRepository3 interface.

Caution: For this operation to succeed, the account you are using must 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 Add(
    [in] BSTR bstrRepositoryName,
    [in] BSTR bstrRepositoryPath,
    [out, retval] IInTrustRepository3**
);

Parameters
Name Type Meaning

bstrRepositoryName

BSTR

Name of the repository.

bstrRepositoryPath

BSTR

UNC path to the share that contains the repository.

 

IInTrustRepository3**

Repository interface.

Remove

Removes the specified repository from the collection, deleting it from the InTrust organization configuration.

Caution: For this operation to succeed, the account you are using must 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 Remove(
    [in] BSTR bstrRepositoryIdentity
);

Parameter
Name Type Meaning

bstrRepositoryIdentity

BSTR

A piece of information that identifies the repository. You can specify one of the following:

  • Repository name
  • Repository GUID
  • UNC path to the repository share

The Item method tries to interpret its input parameter as each of these identifiers, in that order.

_NewEnum

References repositories in a collection.

Syntax

HRESULT _NewEnum(
    [out, retval] LPUNKNOWN* pVal
);

Parameter
Name Type Meaning

pVal

LPUNKNOWN*

Access to repositories in a collection.

IInTrustRepositorySearcher

Provides repository search capabilities.

Method

Search

Runs a repository search using the specified query.

Syntax

HRESULT ID(
    [in] BSTR rel_query,
    [out] IObservable** search_object
);

Parameters
Name Type Meaning

rel_query

BSTR

Search query.

search_object

IObservable

Interface that you can subscribe to for search results.

Documentos relacionados