The LogPhoneLineSipMessages API procedure can be called if you want to generate SIP log files for individual phone lines. Useful for debugging SIP session related problems.
Note that this API procedure can be called to enable SIP phone line logging even if global SIP log file generation has not been enabled in the media engine VoipMediaEngine..::.START_SIP_TELEPHONY_PARAMS structure that gets passed to the StartSipTelephony API procedure.

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


public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE LogPhoneLineSipMessages(
	int PhoneLine,
	bool Enable,
	string SipLogFileName
Visual Basic (Declaration)
Public Function LogPhoneLineSipMessages ( _
	PhoneLine As Integer, _
	Enable As Boolean, _
	SipLogFileName As String _
Visual C++
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE LogPhoneLineSipMessages(
	int PhoneLine, 
	bool Enable, 
	String^ SipLogFileName
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE LogPhoneLineSipMessages(
	int PhoneLine,
	boolean Enable,
	String SipLogFileName


Type: System..::.Int32
The zero based phone line.
Type: System..::.Boolean
Specifies the enable state of phone line SIP logging. Set to a non zero value (TRUE) to enable SIP logging for the phone line or zero (FALSE) to disable SIP logging for the phone line.
Type: System..::.String
The name of the SIP log file to create. If disabling phone line SIP logging, this value is ignored and can be NULL

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

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)

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)

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)



See Also