h324GetTermCaps

Queries the H.324M Middleware for local or remote terminal capabilities.

Prototype

DWORD h324GetTermCaps ( MSPHD msphd, WORD location, H324_TERM_CAPS * termCaps)

Argument

Description

msphd

MSPP handle associated with the MUX endpoint..

location

Indicates whether the function applies to the local terminal capabilities set or the remote terminal capabilities set. Valid values are:

H324_LOCAL_TERMINAL - Local terminal capabilities set.

H324_REMOTE_TERMINAL - Remote terminal capabilities set.

termCaps

Pointer to the H324_TERM_CAPS structure, which communicates the MUX and media capabilities of the remote terminal and the host application:

typedef struct tag_H324_TERM_CAPS
{
   DWORD                    size;
    MULTIPLEX_CAPABILITY      muxCap;
   DWORD                     wCapCount;  // Number of caps
   H324_MEDIA_CAPABILITY    capTable[16];
} H324_TERM_CAPS;

For information about the fields in this structure, see H324_TERM_CAPS.

Return values

Return value

Description

SUCCESS

 

CTAERR_NOT_FOUND

msphd was not found. Either h324Start was not called or h324Delete was called.

H324ERR_INTERNAL_ERROR

Internal error in the 3G-324M Middleware.

H324ERR_MUTEX_LOCK_FAILED

Internal error trying to lock mutex.

H324ERR_NOT_INITIALIZED

h324Initialize was not called first.

Events

None.

Details

For the outbound terminal capabilities set, use h324GetTermCaps to retrieve the default set of terminal capabilities structures based on either the:

You then edit specific parameters in these structures as required, and pass them back to the H.324M Middleware using h324SetTermCaps.

For the inbound terminal capabilities set, you can retrieve a copy of the set at any time after receiving the H324EVN_REMOTE_CAPS. If you issue this request before receiving the H324EVN_REMOTE_CAPS, the function returns H324ERR_INTERNAL_ERROR.

If no terminal capabilities have been set by the application, the default terminal capabilities are returned.

Example

ret = h324GetTermCaps( pCfg-> MuxEp.hd, H324_REMOTE_TERMINAL, & remoteTermCaps);
if ( ret != SUCCESS)
{
    printf("h324GetTermCaps. Return code is % x\n", ret);
    return ret;
}
    printf("Call to Remote h324GetTermCaps returned %d capabilities\n",
            remoteTermCaps.wCapCount );