InTrust 11.6 - InTrust SDK Reference

ISite

Represents an InTrust site, which can be a regular site visible in InTrust Manager or a hidden internal site associated with a collection visible in InTrust Deployment Manager.

To work with methods that are specific to sites of the Microsoft Windows Network type, cast this to IMicrosoftNetworkSite

Methods

Description (getter)

Returns the description of the site.

Syntax

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

Parameter

Description (setter)

Sets the description of the site.

Syntax

HRESULT Description(
    [in]BSTR bstrDescription
);

Parameter

EnumerationPeriod (getter)

Returns the interval (in hours) between site enumerations that refresh the site membership.

Syntax

HRESULT EnumerationPeriod(
    [out, retval] long* pEnumerationPeriod
);

Parameter

EnumerationPeriod (setter)

Sets the interval (in hours) between site enumerations that refresh the site membership.

Syntax

HRESULT EnumerationPeriod(
    [in] long enumerationPeriod
);

Parameter

ID

Returns the ID of the site.

Syntax

HRESULT ID(
    [out, retval] BSTR* pID
);

Parameter

Name (getter)

Returns the name of the site.

Syntax

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

Parameter

Name (setter)

Sets the name of the site.

Syntax

HRESULT Name(
    [in]BSTR bstrName
);

Parameter

Server (getter)

Returns the InTrust server that manages the site.

Syntax

HRESULT Server(
    [out, retval] IInTrustServer3** ppServer
);

Parameter

Server (setter)

Sets the InTrust server that manages the site.

Syntax

HRESULT Server(
    [in] IInTrustServer3* pServer
);

Parameter

SiteObjects

Provides access to the collection of objects in the site.

Syntax

HRESULT SiteObjects(
    [out, retval] ISiteObjectCollection** pSiteObjects
);

Parameter

Type

Returns the type of the site.

Syntax

HRESULT Type(
    [out, retval] enum SiteType* pSiteType
);

Parameter

ISiteComputer

Represents a computer that is included in an InTrust site.

Methods

AccessName

Returns the access name of the computer. This is either the IP address or the same as the name returned by the OriginalName method.

Syntax

HRESULT AccessName(
    [out, retval] BSTR* pbstrName
);

Parameter

AgentID

Returns the ID of the agent installed on the computer.

Syntax

HRESULT AgentID(
    [out, retval] BSTR* pbstrAgentID
);

Parameter

Alive

Returns whether the computer is treated as active by the InTrust server.

Syntax

HRESULT Alive(
    [out, retval] VARIANT_BOOL* pvbAlive
);

Parameter

IPAddress

Returns the IP address of the computer.

Syntax

HRESULT IPAddress(
    [out, retval] long* lIP
);

Parameter

Name

Returns the name of the computer, as shown, for example, in the system properties in Windows.

Syntax

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

Parameter

OfficialHostName

Returns the official host name of the computer. This is either the FQDN or the canonical name, whichever is the result of resolving the name.

Syntax

HRESULT OfficialHostName(
    [out, retval] BSTR* pbstrName
);

Parameter

OriginalName

Returns the original name of the computer. This is the name that was originally provided by the user for adding the computer to the site.

Syntax

HRESULT OriginalName(
    [out, retval] BSTR* pbstrName
);

Parameter

Status

Returns the current status of the computer.

Syntax

HRESULT Status(
    [out, retval] BSTR* pbstrName
);

Parameter

ISiteIndexBuilder

Represents the distributed indexing configuration for a repository.

Methods

IndexAccess

Provides access to the security settings for distributed indexing of the repository.

Syntax

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

Parameters

SiteId (getter)

Returns the ID of the InTrust site whose agents must perform distributed indexing operations.

Syntax

HRESULT SiteId(
    [out, retval] BSTR* siteId
);

Parameter

SiteId (setter)

Specifies the ID of the InTrust site whose agents must perform distributed indexing operations.

Syntax

HRESULT SiteId(
    [in] BSTR siteId
);

Parameter

IndexBuilderAccess

Provides access to the security settings for performing repository indexing.

Syntax

HRESULT IndexBuilderAccess(
    [in, defaultvalue(CurrentIndexBuilderAccess)] enum IndexBuilderAccessType,
    [out, retval] IIndexBuilderAccess** pIndexPathType
);

Parameters

ISiteObject

Represents a computer-specifying object that can be included in an InTrust site. Sites can be populated by indicating computers in a variety of ways, including IP ranges and Active DIrectory domains.

Methods

Type

Returns the type of the site object.

Syntax

HRESULT Type(
    [out, retval]enum SiteObjectType* type
);

Parameter

ID

Returns the ID of the site object.

Syntax

HRESULT ID(
    [out, retval] BSTR* pID
);

Parameter