The FilterEventLogServerEvents API procedure can be called to specify one or more remote event log events
you want filtered. Events that are filtered will not be sent to a remote event log server even though you
have an event log server enabled. The primary purpose of this API procedure is to allow application
software to filter out any events that are not important for the current operation you are investigating
or debugging. A good use of this API procedure is to filter out all SipModifySipMessage immediate events.
Namespace:
LanScapeYou can call this procedure as many times as required to add your event filter values to the internal filter list maintained by the media engine.
Assembly: LMEVoipManaged (in LMEVoipManaged.dll) Version: 6.0.5226.26700
Syntax
C# |
---|
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE FilterEventLogServerEvents( VoipMediaEngine..::.TELEPHONY_RETURN_VALUE FilterValue, bool ClearFilterList ) |
Visual Basic (Declaration) |
---|
Public Function FilterEventLogServerEvents ( _ FilterValue As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE, _ ClearFilterList As Boolean _ ) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE |
Visual C++ |
---|
public: VoipMediaEngine..::.TELEPHONY_RETURN_VALUE FilterEventLogServerEvents( VoipMediaEngine..::.TELEPHONY_RETURN_VALUE FilterValue, bool ClearFilterList ) |
J# |
---|
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE FilterEventLogServerEvents( VoipMediaEngine..::.TELEPHONY_RETURN_VALUE FilterValue, boolean ClearFilterList ) |
Parameters
- FilterValue
- Type: LanScape..::.VoipMediaEngine..::.TELEPHONY_RETURN_VALUE
Specifies the event to filter. Any valid value from the VoipMediaEngine..::.TELEPHONY_RETURN_VALUE enumeration can be specified.
- ClearFilterList
- Type: System..::.Boolean
If set to a non zero value, the internal filter list in the media engine will be cleared. In this case, the value specified by parameter FilterValue is ignored.
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) |
Remarks
None.