The ModifySipMessage API procedure can be called by application software to change the contents of a received or ready-to-be-transmitted SIP message. This API procedure can only be called when an application processes the SipModifySipMessage event.
Note:
Application software can use any means available to parse and modify SIP messages. If your application performs SIP message modifications, make sure you understand the appropriate SIP RFC specifications. Altering SIP messages improperly may impact your ability to successfully inter-operate with other SIP software or devices.

Namespace:  LanScape
Assembly:  LMEVoipManaged (in LMEVoipManaged.dll) Version: 6.0.5226.26700

Syntax

C#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE ModifySipMessage(
	VoipMediaEngine..::.SIP_MESSAGE OriginalSipMsg,
	string NewSipMsgStr
)
Visual Basic (Declaration)
Public Function ModifySipMessage ( _
	OriginalSipMsg As VoipMediaEngine..::.SIP_MESSAGE, _
	NewSipMsgStr As String _
) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE
Visual C++
public:
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE ModifySipMessage(
	VoipMediaEngine..::.SIP_MESSAGE^ OriginalSipMsg, 
	String^ NewSipMsgStr
)
J#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE ModifySipMessage(
	VoipMediaEngine..::.SIP_MESSAGE OriginalSipMsg,
	String NewSipMsgStr
)

Parameters

OriginalSipMsg
Type: LanScape..::.VoipMediaEngine..::.SIP_MESSAGE
This parameter is used to specify the original SIP message to be modified. When application software processes the SipModifySipMessage event, this parameter must be set to the string value that is specified in the SipMsg member of the VoipMediaEngine..::.SIP_MESSAGE_IMMEDIATE_DATA class that is passed to the application during the event.
NewSipMsgStr
Type: System..::.String
An application supplied buffer containing the new SIP message.

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 ValueDescription
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)

SipMemoryError
The telephony engine attempted to allocate system memory but the allocation failed. Make sure the host system has enough virtual memory. Increasing the amount of virtual memory can remove these errors, however if critical telephony engine code has been swapped out to disk and is not resident in physical memory, you may experience degraded audio/video performance. If you want to remove this error and obtain the best possible audio/video performance, make sure the host system has enough physical memory. To resolve this error, you may also want to consider disabling certain features of the media engine such as conference calling. You can also reduce memory requirements if you reduce the maximum signal length of internal media engine signal paths by specifying a smaller number for the MaxMixerLinebuffers member of the VoipMediaEngine..::.START_SIP_TELEPHONY_PARAMS class that is passed to the StartSipTelephony(VoipMediaEngine..::.START_SIP_TELEPHONY_PARAMS) and ReStartSipTelephony(VoipMediaEngine..::.START_SIP_TELEPHONY_PARAMS) API procedures.

(API return value, PHONE_LINE_NOTIFICATION)

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)

Remarks

None.

See Also