sipxmedialib  Version 3.3
Functions | Variables
ISetSrcDescription.h File Reference
#include "rtcp/RtcpConfig.h"
#include "IBaseClass.h"
Include dependency graph for ISetSrcDescription.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

virtual bool SetName (unsigned char *puchCName, unsigned long ulLength)=0
 
virtual bool SetEmail (unsigned char *puchEmail, unsigned long ulLength=0)=0
 
virtual bool SetPhone (unsigned char *puchPhone, unsigned long ulLength)=0
 
virtual bool SetAppName (unsigned char *puchAppName, unsigned long ulLength)=0
 
virtual bool SetLocation (unsigned char *puchLocation, unsigned long ulLength)=0
 
virtual bool SetNotes (unsigned char *puchNotes, unsigned long ulLength)=0
 
virtual bool SetPrivate (unsigned char *puchPrivate, unsigned long ulLength)=0
 

Variables

interface unsigned char * puchEmail =NULL
 
interface unsigned char unsigned char * puchPhone =NULL
 
interface unsigned char unsigned char unsigned char * puchLocation =NULL
 
interface unsigned char unsigned char unsigned char unsigned char * puchAppName =NULL
 
interface unsigned char unsigned char unsigned char unsigned char unsigned char * puchNotes =NULL
 
interface unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char * puchPrivate =NULL)
 

Function Documentation

virtual bool SetName ( unsigned char *  puchCName,
unsigned long  ulLength 
)
pure virtual

Method Name: SetName

Inputs: unsigned char *puchName - NAME Character String unsigned long ulLength - Optional Length of NAME argument passed

Outputs: None

Returns: bool bChanged - Flag identifying whether item has changed

Description: Stores the Name field and length, either specified of derived, as attribute data within the object.

Usage Notes: The NAME argument MUST be passed as a NULL terminated string or must contain a valid length argument. All text strings passed shall be truncated beyond the length of 255 characters.

virtual bool SetEmail ( unsigned char *  puchEmail,
unsigned long  ulLength = 0 
)
pure virtual

Method Name: SetEmail

Inputs: unsigned char *puchEmail - EMAIL character string unsigned long ulLength - Optional Length of Email argument passed

Outputs: None

Returns: bool bChanged - Flag identifying whether item has changed

Description: Stores the Email field and length, either specified of derived, as attribute data within the object.

Usage Notes: The EMAIL argument MUST be passed as a NULL terminated string or must contain a valid length argument. All text strings passed shall be truncated beyond the length of 255 characters.

virtual bool SetPhone ( unsigned char *  puchPhone,
unsigned long  ulLength 
)
pure virtual

Method Name: SetPhone

Inputs: unsigned char *puchPhone - PHONE character string unsigned long ulLength - Optional Length of Phone argument passed

Outputs: None

Returns: bool bChanged - Flag identifying whether item has changed

Description: Stores the Phone field and length, either specified of derived, as attribute data within the object.

Usage Notes: The PHONE argument MUST be passed as a NULL terminated string or must contain a valid length argument. All text strings passed shall be truncated beyond the length of 255 characters.

virtual bool SetAppName ( unsigned char *  puchAppName,
unsigned long  ulLength 
)
pure virtual

Method Name: SetAppName

Inputs: unsigned char *puchAppName - Application Name character string unsigned long ulLength - Optional Length of APP NAME argument passed

Outputs: None

Returns: bool bChanged - Flag identify whether item has changed

Description: Stores the App Name field and length, either specified of derived, as attribute data within the object.

Usage Notes: The APP NAME argument MUST be passed as a NULL terminated string or must contain a valid length argument. All text strings passed shall be truncated beyond the length of 255 characters.

virtual bool SetLocation ( unsigned char *  puchLocation,
unsigned long  ulLength 
)
pure virtual

Method Name: SetLocation

Inputs: unsigned char *puchLocation - Location character string unsigned long ulLength - Optional Length of Location argument passed

Outputs: None

Returns: bool bChanged - Flag identifying whether item has changed

Description: Stores the Location field and length, either specified of derived, as attribute data within the object.

Usage Notes: The LOCATION argument MUST be passed as a NULL terminated string or must contain a valid length argument. All text strings passed shall be truncated beyond the length of 255 characters.

virtual bool SetNotes ( unsigned char *  puchNotes,
unsigned long  ulLength 
)
pure virtual

Method Name: SetNotes

Inputs: unsigned char *puchNotes - Notes character string unsigned long ulLength - Optional Length of Notes argument passed

Outputs: None

Returns: bool bChanged - Flag identifying whether item has changed

Description: Stores the Notes field and length, either specified of derived, as attribute data within the object.

Usage Notes: The NOTES argument MUST be passed as a NULL terminated string or must contain a valid length argument. All text strings passed shall be truncated beyond the length of 255 characters.

virtual bool SetPrivate ( unsigned char *  puchPrivate,
unsigned long  ulLength 
)
pure virtual

Method Name: SetPrivate

Inputs: unsigned char *puchNotes - Private character string unsigned long ulLength - Optional Length of Private argument passed

Outputs: None

Returns: bool bChanged - Flag identifying whether item has changed

Description: Stores the Private field and length, either specified of derived, as attribute data within the object.

Usage Notes: The PRIVATE argument MUST be passed as a NULL terminated string or must contain a valid length argument. All text strings passed shall be truncated beyond the length of 255 characters.

Variable Documentation

interface unsigned char* puchEmail =NULL
interface unsigned char unsigned char* puchPhone =NULL
interface unsigned char unsigned char unsigned char* puchLocation =NULL
interface unsigned char unsigned char unsigned char unsigned char* puchAppName =NULL
interface unsigned char unsigned char unsigned char unsigned char unsigned char* puchNotes =NULL
interface unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char* puchPrivate =NULL)