The SetCallInstanceData API is used when an application is transmitting call instance data with a phone
call. This API procedure is used by the transmitting end of a call to specify the actual byte values of
the call's instance data. Call instance data can be ASCII or raw binary data and its format is dictated by the
application. Call instance data that is part of a phone call can be used for whatever reasons the
application requires. Generally, an application should associate no more than 512 bytes of instance data with
any phone call in order for UDP network packets to remain as small as possible. However, there is no
maximum limit imposed on user defined call instance data.
Namespace:
LanScapeGenerally you would call this procedure when the event callback sends you the SipOutgoingCallInitializing or the SipOutgoingTransferInitializing event indication.
Assembly: LMEVoipManaged (in LMEVoipManaged.dll) Version: 6.0.5226.26700
Syntax
| C# |
|---|
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetCallInstanceData( int PhoneLine, byte[] UserCallInstanceData ) |
| Visual Basic (Declaration) |
|---|
Public Function SetCallInstanceData ( _ PhoneLine As Integer, _ UserCallInstanceData As Byte() _ ) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE |
| Visual C++ |
|---|
public: VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetCallInstanceData( int PhoneLine, array<unsigned char>^ UserCallInstanceData ) |
| J# |
|---|
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetCallInstanceData( int PhoneLine, byte[] UserCallInstanceData ) |
Parameters
- PhoneLine
- Type: System..::.Int32
The zero based phone line to access.
- UserCallInstanceData
- Type: array<
System..::.Byte
>[]()[]
A reference to the application's call instance data. This data will be sent to the receiving end of the call.
Return Value
If the function succeeds, the return value will be SipSuccess.
If the function fails, the return value will be one of the following values as specified by the VoipMediaEngine..::.TELEPHONY_RETURN_VALUE data type.
| Return Value | Description |
|---|---|
| SipCallFailure |
This value is returned by telephony API procedures to indicate general API failure. This error value is used as a "catch all error". If you receive this error, check to make sure that all parameters specified in the API procedure call are correct. Particularly, verify that pointers to memory regions are valid. This error return value is only used if a mapping to another specific error value does not exist.
(API return value) |
| SipBadParameter |
One of the telephony API procedures was called by application software and was passed a pointer to an invalid
memory address. Normally this error will occur when application software passes NULL pointer values to the telephony API.
For managed code applications, you should never see this error unless your process space has exhausted memory.
(API return value) |
| SipInvalidHandle |
Application software specified an invalid telephony handle in one of the API procedures.
This usually indicates memory corruption on the part of application software.
(API return value) |
| SipBadPhoneLine |
Application software called a telephony API procedure and specified an invalid phone line. Phone lines are numbered starting from zero. This error is most commonly returned when attempting to access phone lines in excess of the max number of lines supported by the telephony engine.
(API return value) |
| SipApiProcNotAllowed |
This error informs an application that it has called an API procedure that can not be executed during the current call state.
(API return value) |
Remarks
None.
See Also
