UNREFERENCED_PARAMETER的作用

本文详细解释了UNREFERENCED_PARAMETER宏的作用及使用场景,并对比了注释参数名称的方法,介绍了如何利用#pragma warning来抑制编译器警告。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

UNREFERENCED_PARAMETER 的作用
2007年06月16日 星期六 14:38
我们从 UNREFERENCED_PARAMETER 开始吧。这个宏在 winnt.h 中定义如下:
#define UNREFERENCED_PARAMETER(P) (P)
  换句话说 UNREFERENCED_PARAMETER 展开传递的参数或表达式。其目的是避免编译器关于未引用参数的警告。许多程序员,包括我在内,喜欢用最高级别的警告 Level 4(/W4)进行编译。Level 4 属于“能被安全忽略的事件”的范畴。虽然它们可能使你难堪,但很少破坏你的代码。例如,在你的程序中可能会有这样一些代码行:

int x=1;
  但你从没用到过 x。也许这一行是你以前使用 x 时留下来的,只删除了使用它的代码,而忘了删除这个变量。Warning Level 4 能找到这些小麻烦。所以,为什么不让编译器帮助你完成可能是最高级别的专业化呢?用Level 4 编译是展示你工作态度的一种方式。如果你为公众使用者编写库,Level 4 则是社交礼节上需要的。你不想强迫你的开发人员使用低级选项清洁地编译他们的代码。
  问题是,Level 4 实在是太过于注意细节,在 Level 4 上,编译器连未引用参数这样无伤大雅的事情也要抱怨(当然,除非你真的有意使用这个参数,这时便相安无事)。假设你有一个函数带来两个参数,但你只使用其中一个:

int SomeFunction(int arg1, int arg2){     return arg1+5;}
使用 /W4,编译器抱怨:

“warning C4100: ''arg2'' : unreferenced formal parameter.”
为了骗过编译器,你可以加上 UNREFERENCED_PARAMETER(arg2)。现在编译器在编译你的引用 arg2 的函数时便会住口。并且由于语句:

arg2;
实际上不做任何事情,编译器不会为之产生任何代码,所以在空间和性能上不会有任何损失。

  细心的人可能会问:既然你不使用 arg2,那当初为何要声明它呢?通常是因为你实现某个函数以满足某些API固有的署名需要,例如,MFC的 OnSize 处理例程的署名必须要像下面这样:

void OnSize(UINT nType, int cx, int cy);
  这里 cx/cy 是窗口新的宽/高,nType 是一个类似 SIZE_MAXIMIZED 或 SIZE_RESTORED 这样的编码,表示窗口是否最大化或是常规大小。一般你不会在意 nType,只会关注 cx 和 xy。所以如果你想用 /W4,则必须使用 UNREFERENCED_PARAMETER(nType)。OnSize 只是上千个 MFC 和 Windows 函数之一。编写一个基于 Windows 的程序,几乎不可能不碰到未引用参数。
  说了这么多关于 UNREFERENCED_PARAMETER 内容。Judy 在她的问题中还提到了另一个 C++ 程序员常用的并且其作用与 UNREFERENCED_PARAMETER 相同的诀窍,那就是注释函数署名中的参数名:

void CMyWnd::OnSize(UINT /* nType */, int cx, int cy){}
  现在 nType 是未命名参数,其效果就像你敲入 OnSize(UINT, int cx, int cy)一样。那么现在的关键问题是:你应该使用哪种方法——未命名参数,还是 UNREFERENCED_PARAMETER?
  大多数情况下,两者没什么区别,使用哪一个纯粹是风格问题。(你喜欢你的 java 咖啡是黑色还是奶油的颜色?)但我认为至少有一种情况必须使用 UNREFERENCED_PARAMETER。假设你决定窗口不允许最大化。那么你便禁用 Maximize 按钮,从系统菜单中删除,同时阻止每一个用户能够最大化窗口的操作。因为你是偏执狂(大多数好的程序员都是偏执狂),你添加一个 ASSERT (断言)以确保代码按照你的意图运行:

void CMyWnd::OnSize(UINT nType, int cx, int cy){     ASSERT(nType != SIZE_MAXIMIZE);     ... // use cx, cy}
  质检团队竭尽所能以各种方式运行你的程序,ASSERT 从没有弹出过,于是你认为编译生成 Release 版本是安全的。但是此时 _DEBUG 定义没有了,ASSERT(nType != SIZE_MAXIMIZE)展开为 ((void)0),并且 nType 一下子成了一个未引用参数!这样进入你干净的编译。你无法注释掉参数表中的 nType,因为你要在 ASSERT 中使用它。于是在这种情况下——你唯一使用参数的地方是在 ASSERT 中或其它 _DEBUG 条件代码中——只有 UNREFERENCED_PARAMETER 会保持编译器在 Debug 和 Release 生成模式下都没有问题。知道了吗?
  结束讨论之前,我想还有一个问题我没有提及,就是你可以象下面这样用 pragma 指令抑制单一的编译器警告:

#pragma warning( disable : 4100 )
4100 是未引用参数的出错代码。pragma 抑制其余文件/模块的该警告。用下面方法可以重新启用这个警告:

#pragma warning( default : 4100 )
  不管怎样,较好的方法是在禁用特定的警告之前保存所有的警告状态,然后,等你做完之后再回到以前的配置。那样,你便回到的以前的状态,这个状态不一定是编译器的默认状态。
  所以你能象下面这样在代码的前后用 pragma 指令抑制单个函数的未引用参数警告:

#pragma warning( push ) #pragma warning( disable : 4100 )void SomeFunction(...){}#pragma warning( pop )
  当然,对于未引用参数而言,这种方法未免冗长,但对于其它类型的警告来说可能就不是这样了。库生成者都是用 #pragma warning 来阻塞警告,这样他们的代码可以用 /W4 进行清洁编译。MFC 中充满了这样的 pragmas 指令。还有好多的 #pragma warning 选项我没有在本文讨论。有关它们的信息请参考相关文档。

#define _WINSOCKAPI_ // 防止 Windows Sockets API 被重复定义 #include <windows.h> #include <sal.h> #include <httpserv.h> #include <stdio.h> // 定义主模块类,继承自 IHttpModule class CHelloWorld : public CHttpModule { public: // 请求开始时触发的方法 REQUEST_NOTIFICATION_STATUS OnBeginRequest( IN IHttpContext* pHttpContext, IN IHttpEventProvider* pProvider ) { // 忽略未使用的参数以避免编译警告 UNREFERENCED_PARAMETER(pProvider); // 用于存储方法调用的 HRESULT 返回值 HRESULT hr; // 获取当前 HTTP 请求的响应对象 IHttpResponse* pHttpResponse = pHttpContext->GetResponse(); // 获取当前 HTTP 请求对象 IHttpRequest* pHttpRequest = pHttpContext->GetRequest(); // 分配一块 512 字节的内存用于后续操作 PCSTR pszBuffer = (PCSTR)pHttpContext->AllocateRequestMemory(512); // 获取原始 HTTP 请求结构体指针 HTTP_REQUEST* prawRequest = pHttpRequest->GetRawHttpRequest(); // 提取请求 URL 的原始字符串 PCSTR Url = prawRequest->pRawUrl; // 判断响应对象是否有效 if (pHttpResponse != NULL) { // 清除现有响应内容 pHttpResponse->Clear(); // 设置响应头 Content-Type 为 text/plain pHttpResponse->SetHeader( HttpHeaderContentType, "text/plain", (USHORT)strlen("text/plain"), TRUE ); // 准备要发送给客户端的文本数据 PCSTR pszBuffer = "Hello World!: OnBeginRequest"; // 定义一个 HTTP 数据块结构体 HTTP_DATA_CHUNK dataChunk; // 设置数据块类型为内存块 dataChunk.DataChunkType = HttpDataChunkFromMemory; // 定义变量用于接收实际写入字节数 DWORD cbSent; // 设置数据块的内存地址 dataChunk.FromMemory.pBuffer = (PVOID)pszBuffer; // 设置数据块长度 dataChunk.FromMemory.BufferLength = (USHORT)strlen(pszBuffer); // 将数据块写入 HTTP 响应流中 hr = pHttpResponse->WriteEntityChunks( &dataChunk, 1, FALSE, TRUE, &cbSent, FALSE ); // 判断写入是否成功 if (FAILED(hr)) { // 若失败,则设置 HTTP 状态码为 500 内部服务器错误 pHttpResponse->SetStatus(500, "Server Error", 0, hr); } // 结束请求处理流程 return RQ_NOTIFICATION_FINISH_REQUEST; } // 继续执行其他请求处理逻辑 return RQ_NOTIFICATION_CONTINUE; } }; // 定义模块工厂类,用于创建模块实例 class CHelloWorldFactory : public IHttpModuleFactory { public: // 获取 HTTP 模块实例的方法 HRESULT GetHttpModule( OUT CHttpModule** ppModule, IN IModuleAllocator* pAllocator ) { // 忽略未使用的参数 UNREFERENCED_PARAMETER(pAllocator); // 创建新的模块实例 CHelloWorld* pModule = new CHelloWorld; // 判断是否分配成功 if (!pModule) { // 如果失败则返回内存不足错误 return HRESULT_FROM_WIN32(ERROR_NOT_ENOUGH_MEMORY); } else { // 成功创建后赋值输出参数 *ppModule = pModule; // 将局部指针置空 pModule = NULL; // 返回成功状态 return S_OK; } } // 销毁模块工厂的方法 void Terminate() { // 删除当前对象释放资源 delete this; } }; // 定义全局模块类,用于处理全局事件 class MyGlobalModule : public CGlobalModule { public: // 应用启动时触发的回调函数 GLOBAL_NOTIFICATION_STATUS OnGlobalApplicationStart( _In_ IHttpApplicationStartProvider* pProvider ) { // 忽略未使用的参数 UNREFERENCED_PARAMETER(pProvider); // 当前示例不启用调试输出 // OutputDebugStringA(LPCSTR("Hello World! : OnGlobalApplicationStart")); // 继续执行其他全局通知 return GL_NOTIFICATION_CONTINUE; } // 应用停止时触发的回调函数 GLOBAL_NOTIFICATION_STATUS OnGlobalApplicationStop( _In_ IHttpApplicationStopProvider* pProvider ) { // 忽略未使用的参数 UNREFERENCED_PARAMETER(pProvider); // 当前示例不启用调试输出 // OutputDebugStringA(LPCSTR("Hello World! : OnGlobalApplicationStop")); // 继续执行其他全局通知 return GL_NOTIFICATION_CONTINUE; } // PreBeginRequest 阶段触发的回调函数 GLOBAL_NOTIFICATION_STATUS OnGlobalPreBeginRequest( IN IPreBeginRequestProvider* pProvider ) { // 忽略未使用的参数 UNREFERENCED_PARAMETER(pProvider); // 当前示例不启用调试输出 // OutputDebugStringA(LPCSTR("Hello World! : OnGlobalPreBeginRequest")); // 继续执行其他全局通知 return GL_NOTIFICATION_CONTINUE; } // 析构方法,用于释放资源 VOID Terminate() { // 删除当前对象释放资源 delete this; } // 构造函数,初始化 Event Viewer 句柄 MyGlobalModule() { // 注册事件源到系统日志服务 m_hEventLog = RegisterEventSource(NULL, LPCSTR("IISADMIN")); } // 析构函数,释放 Event Viewer 资源 ~MyGlobalModule() { // 判断句柄是否有效 if (NULL != m_hEventLog) { // 释放句柄并置空 DeregisterEventSource(m_hEventLog); m_hEventLog = NULL; } } private: // 事件日志句柄 HANDLE m_hEventLog; // 写入事件日志的方法 BOOL WriteEventViewerLog(LPCSTR szNotification) { // 判断句柄是否有效 if (NULL != m_hEventLog) { // 报告事件信息到 Event Viewer return ReportEvent( m_hEventLog, EVENTLOG_INFORMATION_TYPE, 0, 0, NULL, 1, 0, &szNotification, NULL ); } // 返回失败状态 return FALSE; } }; // 模块注册入口函数,由 IIS 调用加载模块 HRESULT __stdcall RegisterModule( DWORD dwServerVersion, IHttpModuleRegistrationInfo* pModuleInfo, IHttpServer* pGlobalInfo ) { // 忽略未使用的参数 UNREFERENCED_PARAMETER(dwServerVersion); UNREFERENCED_PARAMETER(pGlobalInfo); // 当前示例不启用调试输出 // OutputDebugStringA(LPCSTR("Hello World! : RegisterModule")); // 创建全局模块实例 MyGlobalModule* pGlobalModule = new MyGlobalModule; // 判断是否创建成功 if (NULL == pGlobalModule) { // 失败则返回内存不足错误 return HRESULT_FROM_WIN32(ERROR_NOT_ENOUGH_MEMORY); } // 注册全局通知,监听 PreBeginRequest 事件 pModuleInfo->SetGlobalNotifications(pGlobalModule, GL_PRE_BEGIN_REQUEST); // 注册请求通知,监听 BeginRequest 事件 return pModuleInfo->SetRequestNotifications( new CHelloWorldFactory, RQ_BEGIN_REQUEST, 0 ); } 我想用IIS模块指定端口访问
最新发布
07-13
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值