Sample Code
Windows Driver Samples/ Windows Filtering Platform Sample/ C++/ lib/ HelperFunctions_GUID.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 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 | //////////////////////////////////////////////////////////////////////////////////////////////////////// Copyright (c) 2012 Microsoft Corporation. All Rights Reserved.//// Module Name:// HelperFunctions_GUID.cpp//// Abstract:// This module contains functions which assist in actions pertaining to GUIDs.//// 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>// {// GUID - Function pertains to GUID objects.// }// <Action>// {// Are - Function compares values.// Create - Function allocates and fills memory.// Destroy - Function cleans up and frees memory.// Is - Function compares values.// Populate - Function fills memory with values.// Purge - Function cleans up values.// }// <Modifier>// {// Equal - Function determines equality between values.// Null - Function determines if value is Null or empty.// String - Function acts on a null terminated wide character string.// }//// Private Functions://// Public Functions:// HlprGUIDsAreEqual(),// HlprGUIDCreate(),// HlprGUIDCreateString(),// HlprGUIDDestroy(),// HlprGUIDDestroyString(),// HlprGUIDIsNull()// HlprGUIDPopulate(),// HlprGUIDPurge(),//// Author:// Dusty Harper (DHarper)//// Revision History://// [ Month ][Day] [Year] - [Revision]-[ Comments ]// May 01, 2010 - 1.0 - Creation//////////////////////////////////////////////////////////////////////////////////////////////////////#include "HelperFunctions_Include.h" /// .static const GUID NULL_GUID = {0};/** @helper_function="HlprGUIDPurge" Purpose: Cleanup a GUID. <br> <br> Notes: <br> <br> MSDN_Ref: <br>*/VOID HlprGUIDPurge(_Inout_ GUID* pGUID){ if(pGUID) ZeroMemory(pGUID, sizeof(GUID)); return;}/** @helper_function="HlprGUIDDestroy" Purpose: Cleanup and free a GUID. <br> <br> Notes: <br> <br> MSDN_Ref: <br>*/_At_(*ppGUID, _Post_ _Null_)VOID HlprGUIDDestroy(_Inout_ GUID** ppGUID){ if(ppGUID) { if(*ppGUID) HlprGUIDPurge(*ppGUID); HLPR_DELETE(*ppGUID); } return;}/** @helper_function="HlprGUIDPopulate" Purpose: Populate a GUID with a random value. <br> <br> Notes: <br> <br> MSDN_Ref: HTTP://MSDN.Microsoft.com/En-US/Library/AA379205.aspx <br>*/_Success_(return == NO_ERROR)UINT32 HlprGUIDPopulate(_Inout_ GUID* pGUID){ UINT32 status = NO_ERROR; if(pGUID) { status = UuidCreate(pGUID); if(status != RPC_S_OK && // 0 status != RPC_S_UUID_LOCAL_ONLY) // 1824 { // RPC_S_UUID_NO_ADDRESS // 1739 HlprLogError(L"HlprGUIDPopulate : UuidCreate() [status: %#x]", status); } else status = NO_ERROR; } else { status = ERROR_INVALID_PARAMETER; HlprLogError(L"HlprGUIDPopulate() [status: %#x][pGUID: %#p]", status, pGUID); } return status;}/** @helper_function="HlprGUIDCreate" Purpose: Allocate and populate a GUID with a random value. <br> <br> Notes: The caller is responsible for freeing the allocated memory using HlprGUIDDestroy(). <br> <br> MSDN_Ref: HTTP://MSDN.Microsoft.com/En-US/Library/AA379205.aspx <br>*/_At_(*ppGUID, _Pre_ _Null_)_When_(return != NO_ERROR, _At_(*ppGUID, _Post_ _Null_))_When_(return == NO_ERROR, _At_(*ppGUID, _Post_ _Notnull_))_Success_(return == NO_ERROR)UINT32 HlprGUIDCreate(_Outptr_ GUID** ppGUID){ UINT32 status = NO_ERROR; if(ppGUID) { HLPR_NEW(*ppGUID, GUID); HLPR_BAIL_ON_ALLOC_FAILURE(*ppGUID, status); status = HlprGUIDPopulate(*ppGUID); HLPR_BAIL_LABEL: if(status != NO_ERROR) { HLPR_DELETE(*ppGUID); } } else { status = ERROR_INVALID_PARAMETER; HlprLogError(L"HlprGUIDCreate() [status: %#x][ppGUID: %#p]", status, ppGUID); } return status;}/** @helper_function="HlprGUIDDestroyString" Purpose: Cleanup and free a string representing a GUID. <br> <br> Notes: Use if string was allocated by HlprGUIDCreateString(). <br> <br> MSDN_Ref: HTTP://MSDN.Microsoft.com/En-US/Library/AA378483.aspx <br>*/_When_(return != NO_ERROR, _At_(*ppGUIDString, _Post_ _Notnull_))_When_(return == NO_ERROR, _At_(*ppGUIDString, _Post_ _Null_))_Success_(return == NO_ERROR)UINT32 HlprGUIDDestroyString(_Inout_ PWSTR* ppGUIDString){ UINT32 status = NO_ERROR; if(ppGUIDString && *ppGUIDString) { status = RpcStringFree(ppGUIDString); if(status != RPC_S_OK) HlprLogError(L"HlprGUIDDestroyString : RpcStringFree() [status: %#x]", status); else *ppGUIDString = 0; } return status;}/** @helper_function="HlprGUIDCreateString" Purpose: Allocate and populate a string representing the provided GUID. <br> <br> Notes: The caller is responsible for freeing the allocated memory using HlprGUIDDestroyString(). <br> <br> MSDN_Ref: HTTP://MSDN.Microsoft.com/En-US/Library/AA379352.aspx <br>*/_Success_(return != 0)PWSTR HlprGUIDCreateString(_In_ const GUID* pGUID){ PWSTR pGUIDString = 0; if(pGUID) { UINT32 status = NO_ERROR; status = UuidToString(pGUID, &pGUIDString); if(status != NO_ERROR) { HlprLogError(L"HlprGUIDCreateString : UuidToString() [status: %#x]", status); } } return pGUIDString;}/** @helper_function="HlprGUIDsAreEqual" Purpose: Determine if two GUIDs are identical. <br> <br> Notes: <br> <br> MSDN_Ref: HTTP://MSDN.Microsoft.com/En-US/Library/AA379329.aspx <br>*/BOOLEAN HlprGUIDsAreEqual(_In_ const GUID* pGUIDAlpha, _In_ const GUID* pGUIDOmega){ RPC_STATUS status = RPC_S_OK; UINT32 areEqual = FALSE; if(pGUIDAlpha == 0 || pGUIDOmega == 0) { if((pGUIDAlpha == 0 && pGUIDOmega) || (pGUIDAlpha && pGUIDOmega == 0)) HLPR_BAIL; } if(pGUIDAlpha == 0 && pGUIDOmega == 0) { areEqual = TRUE; HLPR_BAIL; } areEqual = UuidEqual((UUID*)pGUIDAlpha, (UUID*)pGUIDOmega, &status); if(status != RPC_S_OK) HlprLogError(L"HlprGUIDsAreEqual : UuidEqual() [status %#x]", status); HLPR_BAIL_LABEL: return (BOOLEAN)areEqual;}/** @helper_function="HlprGUIDIsNull" Purpose: Determine if a GUID is a NULL GUID. <br> <br> Notes: <br> <br> MSDN_Ref: <br>*/BOOLEAN HlprGUIDIsNull(_In_ const GUID* pGUID){ return HlprGUIDsAreEqual(pGUID, (GUID*)&NULL_GUID);;} |
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
