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

IForwardingFilterCollection

Provides a collection of all search-based filters associated with an InTrust repository.

Methods

_NewEnum

Returns an enumerator for the collection.

Syntax

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

Parameter
Name Type Meaning

pVal

LPUNKNOWN*

Collection enumerator.

Add

Adds a new filter based on a Repository Viewer search.

Syntax

HRESULT Add(
    [in] BSTR bstrPath
);

Parameter
Name Type Meaning

bstrPath

BSTR

Path to the Repository Viewer search to make the new filter from. At this time, an internal representation of the path is expected, and there is no usable way to look it up for a specific search. Later implementations should fix this.

Remove

Removes the specified filter from the collection. To specify the filter, pass in the path to its corresponding Repository Viewer search.

Syntax

HRESULT Remove(
    [in] BSTR bstrPath
);

Parameter
Name Type Meaning

bstrPath

BSTR

Path to the Repository Viewer search to make the new filter from.

IForwardingSettings

Provides access to the event forwarding settings for a repository.

Methods

ForwardingEnabled (getter)

Returns whether event forwarding is enabled for the repository.

Syntax

HRESULT ForwardingEnabled(
    [out, retval] VARIANT_BOOL* pForwardingEnabled
);

Parameter
Name Type Meaning

pForwardingEnabled

VARIANT_BOOL*

Whether event forwarding is enabled for the repository.

ForwardingEnabled (setter)

Enables or disables event forwarding for the repository.

Syntax

HRESULT ForwardingEnabled(
    [in] VARIANT_BOOL ForwardingEnabled
);

Parameter
Name Type Meaning

pForwardingEnabled

VARIANT_BOOL

Whether to enable or disable event forwarding for the repository.

ForwardingFilters

Returns the collection of repository searches used as forwarding filters. Management of these filters is outside the scope of the InTrust SDK.

Syntax

HRESULT ForwardingFilters(
    [out, retval] IForwardingFilterCollection** ppForwardingFilters
);

Parameter
Name Type Meaning

ppForwardingFilters

IForwardingFilterCollection**

Repository searches used as forwarding filters.

ForwardingServer (getter)

Returns the InTrust server that manages event forwarding from the repository.

Syntax

HRESULT ForwardingServer(
    [out, retval] IInTrustServer3** ppForwardingServer
);

Parameters
Name Type Meaning

ppForwardingServer

IInTrustServer3**

InTrust server that manages event forwarding from the repository.

ForwardingServer (setter)

Sets the InTrust server that manages event forwarding from the repository.

Syntax

HRESULT ForwardingServer(
    [in] IInTrustServer3* pForwardingServer
);

Parameters
Name Type Meaning

pForwardingServer

IInTrustServer3*

InTrust server that manages event forwarding from the repository.

Host (getter)

Returns the name or IP address of the destination host for event forwarding.

Syntax

HRESULT Host(
    [out, retval] BSTR* bstrHost
);

Parameter
Name Type Meaning

bstrHost

BSTR*

Name or IP address of the destination host for event forwarding.

Host (setter)

Sets the name or IP address of the destination host for event forwarding.

Syntax

HRESULT Host(
    [in] BSTR bstrHost
);

Parameter
Name Type Meaning

bstrHost

BSTR

Name or IP address of the destination host for event forwarding.

MessageFormat (getter)

Returns the details of the message format used for event forwarding from the repository.

Syntax

HRESULT MessageFormat(
    [out, retval] IMessageFormatInfo** ppMessageFormatInfo
);

Parameter
Name Type Meaning

ppMessageFormatInfo

IMessageFormatInfo**

Details of the message format used for event forwarding from the repository.

MessageFormat (setter)

Sets the message format to use for event forwarding from the repository.

Syntax

HRESULT MessageFormat(
    [in] IMessageFormatInfo* pMessageFormatInfo
);

Parameter
Name Type Meaning

pMessageFormatInfo

IMessageFormatInfo*

Details of the message format used for event forwarding from the repository.

Port (getter)

Returns the destination port for event forwarding.

Syntax

HRESULT Port(
    [out, retval] BSTR* bstrPort
);

Parameter
Name Type Meaning

bstrPort

BSTR*

Destination port for event forwarding.

Port (setter)

Sets the destination port for event forwarding.

Syntax

HRESULT Port(
    [in] BSTR bstrPort
);

Parameter
Name Type Meaning

bstrPort

BSTR

Destination port for event forwarding.

TransportInfo (getter)

Returns the details of the transport selected for event forwarding from the repository.

Syntax

HRESULT Transport(
    [out, retval] ITransportInfo** ppTransportInfo
);

Parameter
Name Type Meaning

ppTransportInfo

ITransportInfo**

Transport selected for event forwarding from the repository.

TransportInfo (setter)

Sets the transport for event forwarding from the repository.

Syntax

HRESULT Transport(
    [in] ITransportInfo* pTransportInfo
);

Parameter
Name Type Meaning

pTransportInfo

ITransportInfo*

Transport selected for event forwarding from the repository.

IIdleRepository

Represents an idle repository. An idle repository has the correct structure on the file system, but is not registered with an InTrust organization. Currently, you can search in idle repositories using the repository API, but you cannot write to them.

Method

Searcher

Returns a searcher interface for the idle repository.

Syntax

HRESULT Searcher(
    [in, optional] VARIANT pIndexManager,
    [out, retval] IInTrustRepositorySearcher** ppSearcher);

Parameters
Name Type Meaning

pIndexManager

VARIANT

Interface that contains details about the index to use for searching in the repository. See IIndexManager for details.

ppSearcher

IInTrustRepositorySearcher**

Searcher interface that you can supply your query to.

IIdleRepositoryFactory

Creates an idle InTrust repository. An idle repository has the correct structure on the file system, but is not registered with an InTrust organization.

Method

MakeIdleRepository

Returns an idle InTrust repository.

Syntax

HRESULT MakeIdleRepository(
    [in] BSTR bstrPath,
    [in] BSTR bstrUser,
    [in] BSTR bstrPassword,
    [out, retval] IIdleRepository **ppRepository);

Parameters
Name Type Meaning

bstrPath

BSTR

Search query.

bstrUser

BSTR

User account to use for the operation.

bstrPassword BSTR

Password to use for the operation.

ppRepository

IIdleRepository

The newly-created idle repository.

Documentos relacionados