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

IScriptArgument

Represents an argument used with an InTrust site enumeration script.

Methods

Description

Returns the description of the argument.

Syntax

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

Parameter
Name Type Meaning

description

BSTR*

Description of the argument.

ID

Returns the ID of the argument.

Syntax

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

Parameter
Name Type Meaning

pID

BSTR*

ID of the argument.

IsCustom

Returns whether this is a custom argument.

Syntax

HRESULT IsCustom(
    [out, retval] VARIANT_BOOL* bIsCustom
);

Parameter
Name Type Meaning

bIsCustom

VARIANT_BOOL*

Whether this is a custom argument.

Name

Returns the name of the argument.

Syntax

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

Parameter
Name Type Meaning

name

BSTR*

Name of the argument.

Value (getter)

Returns the value of the argument.

Syntax

HRESULT Value(
    [out, retval] BSTR* value
);

Parameter
Name Type Meaning

value

BSTR*

Value of the argument.

Value (setter)

Sets the value of the argument.

Syntax

HRESULT Value(
    [in] BSTR value
);

Parameter
Name Type Meaning

value

BSTR

Value of the argument.

 

IScriptArgumentCollection

Represents the arguments defined for an InTrust script.

Methods

_NewEnum

Returns an enumerator for the collection.

Syntax

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

Parameter
Name Type Meaning

pVal

LPUNKNOWN*

Collection enumerator.

Item

Gets an argument from the collection by name.

Syntax

HRESULT Item(
    [in] BSTR bstrArgumentName,
    [out, retval] IScriptArgument** ppArgument
);

Parameters
Name Type Meaning

bstrArgumentName

BSTR

Name of the argument

ppArgument

IScriptArgument**

The returned argument.

IScriptParameter

Represents a customizable parameter defined for an InTrust script.

Methods

DefaultValue (getter)

Returns the default value of the parameter.

Syntax

HRESULT DefaultValue(
    [out, retval] BSTR* bstrDefaultValue
);

Parameter
Name Type Meaning

bstrDefaultValue

BSTR*

Default value of the parameter.

DefaultValue (setter)

Sets the default value for the parameter.

Syntax

HRESULT DefaultValue(
    [in] BSTR bstrDefaultValue
);

Parameter
Name Type Meaning

bstrDefaultValue

BSTR

Default value of the parameter.

Description (getter)

Returns the description of the parameter.

Syntax

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

Parameter
Name Type Meaning

bstrDescription

BSTR*

Description of the parameter.

Description (setter)

Sets the description of the parameter.

Syntax

HRESULT Description(
    [in] BSTR bstrDescription
);

Parameter
Name Type Meaning

bstrDescription

BSTR

Description of the parameter.

ID

Returns the ID of the script parameter.

Syntax

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

Parameter
Name Type Meaning

bstrID

BSTR*

ID of the script parameter.

Name (getter)

Returns the name of the parameter.

Syntax

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

Parameter
Name Type Meaning

bstrName

BSTR*

Name of the parameter.

Name (setter)

Sets the name of the parameter.

Syntax

HRESULT Name(
    [in] BSTR bstrName
);

Parameter
Name Type Meaning

bstrName

BSTR

Name of the parameter.

 

IScriptParameterCollection

Represents the parameters defined for an InTrust script.

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 parameter to the collection.

Syntax

HRESULT Add(
    [out, retval] IScriptParameter** ppParameter
);

Parameters
Name Type Meaning

ppParameter

IScriptParameter**

Parameter to add to the collection.

Item

Gets a parameter from the collection by name.

Syntax

HRESULT Item(
    [in] BSTR bstrParameterName,
    [out, retval] IScriptParameter** ppParameter
);

Parameters
Name Type Meaning

bstrParameterName

BSTR

Name of the parameter.

ppParameter

IScriptParameter**

The returned parameter.

Remove

Removes the parameter with the specified name from the collection.

Syntax

HRESULT Remove(
    [in] BSTR bstrParameterName
);

Parameter
Name Type Meaning

bstrParameterName

BSTR

Name of the parameter to remove.

Documentos relacionados