Chat now with support
Chat with Support

InTrust 11.6.1 - InTrust SDK Reference

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

IMessageFormatCustomInfo

Represents a customizable script-based message formatter used for event forwarding.

Methods

Data (getter)

Returns the custom script that implements the functionality of the formatter.

Syntax

HRESULT Data(
    [out, retval] BSTR* bstrData
);

Parameters
Name Type Meaning

bstrData

BSTR*

Custom script that implements the functionality of the formatter.

Data (setter)

Supplies the custom script that implements the functionality of the formatter.

Syntax

HRESULT Data(
    [in] BSTR bstrData
);

Parameters
Name Type Meaning

bstrData

BSTR

Custom script that implements the functionality of the formatter.

 

IMessageFormatInfo

Provides access to the formatting configuration for forwarded events.

Methods

MessageFormatType

Returns the configuration of message format.

Syntax

HRESULT MessageFormatType(
    [out, retval] IMessageFormatTypeInfo** ppMessageFormatTypeInfo
);

Parameter
Name Type Meaning

ppMessageFormatTypeInfo

IMessageFormatTypeInfo**

Configuration of the message format.

Name

Returns the display name of the message format.

Syntax

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

Parameter
Name Type Meaning

val

BSTR*

Display name of the message format.

IMessageFormatTypeInfo

Defines a message format for forwarded events and can be used as a template for creating new formats.

Methods

CreateMessageFormat

Returns a new message format item.

Syntax

HRESULT CreateMessageFormat(
    [out, retval]IMessageFormatInfo** ppMessageFormat
);

Parameters
Name Type Meaning

ppMessageFormat

IMessageFormatInfo**

New message format for forwarded events.

GUID

Returns the GUID of the message format.

Syntax

HRESULT GUID(
    [out, retval] BSTR* GUID
);

Parameters
Name Type Meaning

GUID

BSTR*

GUID of the message format.

IsCustomizable

Returns whether this is a customizable script-based message format.

Syntax

HRESULT IsCustomizable(
    [out, retval] VARIANT_BOOL* val
);

Parameters
Name Type Meaning

val

VARIANT_BOOL*

Whether this is a customizable script-based message format.

Name

Returns the display name of the message format.

Syntax

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

Parameters
Name Type Meaning

val

BSTR*

Display name of the message format.

 

IMessageFormatTypeInfoCollection

Provides a collection of all message format types supported by InTrust event forwarding.

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 a message format type from the collection by GUID.

Syntax

HRESULT Item(
    [in] BSTR GUID,
    [out, retval] IMessageFormatTypeInfo**
);

Parameters
Name Type Meaning

GUID

BSTR

GUID of the message format type.

 

IMessageFormatTypeInfo**

The message format type.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating