Wiki

This version (10 Feb 2021 11:02) was approved by Sreesha Y M.

Click here to go back

adi_ss_comm_GetProperties


Prototype

 ADI_SS_COMM_RESULT adi_ss_comm_GetProperties(ADI_SS_COMM_HANDLE hSSComm, 
                                              ADI_SS_COMM_PROPERTIES *pCommProperties 
                                             )


Description
API for getting current communication properties.

Parameters

Name: pCommProperties
Type: ADI_SS_COMM_PROPERTIES
Direction: Input
Description: Pointer to structure of type ADI_SS_COMM_PROPERTIES. The fields of this structure is updated by the 
             communication component.

Name: hSSComm
Type: ADI_SS_COMM_HANDLE
Direction: Input
Description: Handle to communication component instance.


Return value
An error code of type ADI_SS_COMM_RESULT is returned.
ADI_SS_COMM_SUCCESS : Communication init successful.
ADI_SS_COMM_FAILED : Communication init failed due to general error.

resources/tools-software/sigmastudiov2/targetintegration/commapi/apifuncs/adi_ss_comm_getproperties.txt · Last modified: 26 Jun 2020 06:29 by Sreesha Y M