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

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
Name Type Meaning

bstrDescription

BSTR*

Description of the site.

Description (setter)

Sets the description of the site.

Syntax

HRESULT Description(
    [in]BSTR bstrDescription
);

Parameter
Name Type Meaning

bstrDescription

BSTR

Description of the site.

EnumerationPeriod (getter)

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

Syntax

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

Parameter
Name Type Meaning

pEnumerationPeriod

long*

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

EnumerationPeriod (setter)

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

Syntax

HRESULT EnumerationPeriod(
    [in] long enumerationPeriod
);

Parameter
Name Type Meaning

pEnumerationPeriod

long

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

ID

Returns the ID of the site.

Syntax

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

Parameter
Name Type Meaning

pID

BSTR*

ID of the site.

Name (getter)

Returns the name of the site.

Syntax

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

Parameter
Name Type Meaning

bstrName

BSTR*

Name of the site.

Name (setter)

Sets the name of the site.

Syntax

HRESULT Name(
    [in]BSTR bstrName
);

Parameter
Name Type Meaning

bstrName

BSTR

Name of the site.

Server (getter)

Returns the InTrust server that manages the site.

Syntax

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

Parameter
Name Type Meaning

ppServer

IInTrustServer3**

InTrust server that manages the site.

Server (setter)

Sets the InTrust server that manages the site.

Syntax

HRESULT Server(
    [in] IInTrustServer3* pServer
);

Parameter
Name Type Meaning

pServer

IInTrustServer3*

InTrust server that manages the site.

SiteObjects

Provides access to the collection of objects in the site.

Syntax

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

Parameter
Name Type Meaning

pSiteObjects

ISiteObjectCollection**

Collection of objects in the site.

Type

Returns the type of the site.

Syntax

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

Parameter
Name Type Meaning

pSiteType

enum SiteType*

Type of the site.

 

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
Name Type Meaning

pbstrName

BSTR*

Access name of the computer.

AgentID

Returns the ID of the agent installed on the computer.

Syntax

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

Parameter
Name Type Meaning

pbstrAgentID

BSTR*

ID of the agent installed on the computer.

Alive

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

Syntax

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

Parameter
Name Type Meaning

pvbAlive

VARIANT_BOOL*

Whether the computer is treated as active by the InTrust server.

IPAddress

Returns the IP address of the computer.

Syntax

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

Parameter
Name Type Meaning

lIP

long*

IP address of the computer.

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
Name Type Meaning

pbstrName

BSTR*

Name of the computer.

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
Name Type Meaning

pbstrName

BSTR*

Official host name of the computer.

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
Name Type Meaning

pbstrName

BSTR*

Original name of the computer.

Status

Returns the current status of the computer.

Syntax

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

Parameter
Name Type Meaning

pbstrName

BSTR*

Current status of the computer.

 

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
Name Type Meaning

 

enum CustomizableCredentialsType

 

pCredentials

ICustomizableCredentials**

Security settings for distributed indexing of the repository.

SiteId (getter)

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

Syntax

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

Parameter
Name Type Meaning

siteId

BSTR*

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

SiteId (setter)

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

Syntax

HRESULT SiteId(
    [in] BSTR siteId
);

Parameter
Name Type Meaning

siteId

BSTR

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

IndexBuilderAccess

Provides access to the security settings for performing repository indexing.

Syntax

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

Parameters
Name Type Meaning

 

enum IndexBuilderAccessType

What kind of account is used for repository indexing.

pIndexPathType

IIndexBuilderAccess**

Security settings for performing repository indexing.

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
Name Type Meaning

type

enum SiteObjectType*

Type of the site object.

ID

Returns the ID of the site object.

Syntax

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

Parameter
Name Type Meaning

pID

BSTR*

ID of the site object.

Documentos relacionados