tfIpsecLogWalk

Jump to: navigation, search

Table of Contents >> IPsec/IKE Programmer's Reference >> IPsec/IKE Function Reference


#include <trsocket.h>


int tfIpsecLogWalk (
ttLogWalkFuncPtr funcPtr,
int msgSeqNo,
ttUserGenericUnion genParam
);


Function Description

Walk the messages in the IPsec circular log buffer in the sequence in which they were logged, optionally starting with a specified message sequence number. If the specified message sequence number is not found, then all messages are walked.


Parameters

  • funcPtr
    Pointer to user-specified function called for each log message. This function returns 0 to continue the walk, otherwise returns non-zero to terminate the walk. The function prototype for the user-specified function is:
     int                   myLogWalk
     (
     int                   msgSeqNo, 
     const char TM_FAR *   pszLogMsg, 
     ttUserGenericUnion    genParam
     );
Where msgSeqNo is the 15-bit sequence number of message pointed by pszLogMsg, and pszLogMsg is a pointer to the null-terminated log message. The log is walked in the forward direction, therefore message sequence numbers will be in ascending order.
  • msgSeqNo
    An optional 15-bit message sequence number specifying where to start the walk. Specify -1 if there is no specific sequence number, and instead you want to walk all messages.
  • GenParam
    A generic parameter that is passed on to the funcPtr when it’s called


Returns

  • TM_ENOERROR
    Successful
  • TM_EPERM
    The log buffer was not available.


Table of Contents >> IPsec/IKE Programmer's Reference >> IPsec/IKE Function Reference