Sample Code

Windows Driver Samples/ Windows Filtering Platform Sample/ C++/ lib/ HelperFunctions_FwpmTransaction.cpp/

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
////////////////////////////////////////////////////////////////////////////////////////////////////
//
//   Copyright (c) 2012 Microsoft Corporation.  All Rights Reserved.
//
//   Module Name:
//      HelperFunctions_FwpmTransaction.cpp
//
//   Abstract:
//      This module contains functions which assist in actions pertaining to BFE transactions.
//
//   Naming Convention:
//
//      <Scope><Module><Object><Action><Modifier>
// 
//      i.e.
//
//       <Scope>
//          {
//                            - Function is likely visible to other modules.
//          }
//       <Module>
//          {
//            Hlpr            - Function is from HelperFunctions_* Modules.
//          }
//       <Object>
//          {
//            FwpmTransaction - Function pertains to BFE engine objects.
//          }
//       <Action>
//          {
//            Abort           - Function ends a transaction without making changes.
//            Begin           - Function starts a transaction.
//            Commit          - Function ends a transaction successfully.
//          }
//       <Modifier>
//          {
//          }
//
//   Private Functions:
//
//   Public Functions:
//      HlprFwpmTransactionAbort(),
//      HlprFwpmTransactionBegin(),
//      HlprFwpmTransactionCommit(),
//
//   Author:
//      Dusty Harper      (DHarper)
//
//   Revision History:
//
//      [ Month ][Day] [Year] - [Revision]-[ Comments ]
//      May       01,   2010  -     1.0   -  Creation
//
////////////////////////////////////////////////////////////////////////////////////////////////////
 
#include "HelperFunctions_Include.h" /// .
 
 
/**
 @helper_function="HlprFwpmTransactionAbort"
  
   Purpose:  Wrapper for the FwpmTransactionAbort API.                                          <br>
                                                                                                <br>
   Notes:                                                                                       <br>
                                                                                                <br>
   MSDN_Ref: HTTP://MSDN.Microsoft.com/En-US/Library/AA364242.aspx                              <br>
*/
_Success_(return == NO_ERROR)
UINT32 HlprFwpmTransactionAbort(_In_ HANDLE engineHandle)
{
   UINT32 status = NO_ERROR;
 
   if(engineHandle)
   {
      status = FwpmTransactionAbort(engineHandle);
      if(status != NO_ERROR)
         HlprLogError(L"HlprFwpmTransactionAbort() [status: %#x]",
                      status);
   }
   else
   {
      status = ERROR_INVALID_PARAMETER;
 
      HlprLogError(L"HlprFwpmTransactionAbort() [status: %#x][engineHandle: %#p]",
                   status,
                   engineHandle);
   }
 
   return status;
}
 
/**
 @helper_function="HlprFwpmTransactionBegin"
  
   Purpose:  Wrapper for the FwpmTransactionBegin API.                                          <br>
                                                                                                <br>
   Notes:    Only need to use if making multiple BFE calls.                                     <br>
                                                                                                <br>
   MSDN_Ref: HTTP://MSDN.Microsoft.com/En-US/Library/AA364243.aspx                              <br>
*/
_Success_(return == NO_ERROR)
UINT32 HlprFwpmTransactionBegin(_In_ HANDLE engineHandle,
                                _In_ UINT32 flags)        /* 0 */
{
   UINT32 status = NO_ERROR;
 
   if(engineHandle)
   {
      status = FwpmTransactionBegin(engineHandle,
                                    flags);
      if(status != NO_ERROR)
         HlprLogError(L"HlprFwpmTransactionBegin() [status: %#x]",
                      status);
   }
   else
   {
      status = ERROR_INVALID_PARAMETER;
 
      HlprLogError(L"HlprFwpmTransactionBegin() [status: %#x][engineHandle: %#p]",
                   status,
                   engineHandle);
   }
 
   return status;
}
 
/**
 @helper_function="HlprFwpmTransactionCommit"
  
   Purpose:  Wrapper for the FwpmTransactionCommit API.                                         <br>
                                                                                                <br>
   Notes:    On failure, transaction gets aborted.                                              <br>
                                                                                                <br>
   MSDN_Ref: HTTP://MSDN.Microsoft.com/En-US/Library/AA364245.aspx                              <br>
*/
_Success_(return == NO_ERROR)
UINT32 HlprFwpmTransactionCommit(_In_ HANDLE engineHandle)
{
   UINT32 status = NO_ERROR;
 
   if(engineHandle)
   {
      status = FwpmTransactionCommit(engineHandle);
      if(status != NO_ERROR)
      {
         HlprLogError(L"HlprFwpmTransactionCommit() [status: %#x]",
                      status);
 
         HlprFwpmTransactionAbort(engineHandle);
      }
   }
   else
   {
      status = ERROR_INVALID_PARAMETER;
 
      HlprLogError(L"HlprFwpmTransactionCommit() [status: %#x][engineHandle: %#p]",
                   status,
                   engineHandle);
   }
 
   return status;
}

Our Services

  • What our customers say about us?

    Read our customer testimonials to find out why our clients keep returning for their projects.

    View Testimonials

© 2011-2025 All Rights Reserved. Joya Systems. 4425 South Mopac Building II Suite 101 Austin, TX 78735 Tel: 800-DEV-KERNEL

Privacy Policy. Terms of use. Valid XHTML & CSS