ami_SessionCreateUsingProperties()

Function

Declaration

ami_Error ami_SessionCreateUsingProperties(
   ami_Session *    inpAmiSession, 
   ami_TraceCode    inTraceLevel, 
   ami_Property *   inpProperties,
   const char *     inpName,
   const char *     inpDisplayName,
   const char *     inpHelp,
   ami_TraceHandler inTraceHandler,
   const void *     inpUserData ); 

Purpose

Creates a new AMI session using transport properties. Each session represents a single TIBCO Hawk microagent.

Create property list using the ami_AddProperty() API and pass it to the ami_SessionCreateUsingProperties() API.

Parameters

 

Parameter

Description

inpAmiSession

Target for returned session handle.

inTraceLevel

AMI trace levels for this AMI session. See ami_TraceCode for trace level descriptions.

inpProperties

AMI transport properties.

inpName

Unique name string for microagent.

inpDisplayName

User-friendly name string for microagent.

inpHelp

User-friendly microagent description.

inTraceHandler

AMI session trace callback function.

inpUserData

AMI session user data.