IMR_SetOpt

This function sets selected client options. Currently sets only the link preference option. Invoke this function before establishing any session to change the link preference from its default value.

Function Header

IMRResult IMR_SetOpt(

ClientID id,

int optname,

const char *optval,

int optlen

);

Function Parameters

Field

Input/Output

Value or Description

id

Input

The ID of the relevant client. If the value is set to INVALID_CLIENT_ID (see Definitions) then the selected option will be applied to all client sessions established after the function was invoked.

optname

Input

Value selected from the SetClientOption enumeration.

optval

Input

Pointer to a value associated with the selected option. Currently this will be an integer set to a value from the CLIENT_LINK_PREFERENCE_OPTION enumeration.

optlen

Input

Length of optval.

Function Return Status

For a complete list of possible error codes, see Error Codes.

Status

Value or Description

IMR_RES_OK

The command finished successfully.

IMR_RES_CLIENT_INVALID_OPTION

Invalid parameter in function call

Copyright © 2006-2013, Intel Corporation. All rights reserved.