LogPhoneLineSipMessages

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 START_SIP_TELEPHONY_PARAMS structure that gets passed to the StartSipTelephony API procedure.

TELEPHONY_RETURN_VALUE LogPhoneLineSipMessages(

SIPHANDLE hStateMachine,

int PhoneLine,

BOOL Enable,

char *pSipLogFileName

);

Parameters:

hStateMachine

[in] The handle to the telephony engine. This is the handle that was returned by a previous call to the StartSipTelephony procedure.

PhoneLine

[in] The zero based phone line.

Enable

[in] 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.

pSipLogFileName

[in] 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 TELEPHONY_RETURN_VALUE data type.

Value	Description
SipCallFailure	This is a generic "catch all" API error. If an error condition is not specified by any other API error value, this error will be returned.
SipBadParameter	For API procedures that receive pointers from user software, this error indicates that a NULL pointer condition was detected. Make sure all pointers your software passes to the telephony API are valid.
SipInvalidHandle	An API procedure was passed an invalid handle. The telephony engine attempts to verify user specified telephony handles and returns this error when an invalid handle is detected.
SipBadPhoneLine	A telephony operation was specified using an invalid phone line. Phone lines are numbered starting from zero.