另一个人们依赖的未文档化行为:输出缓冲区
对于一个通过输出缓冲区来返回数据的函数,如果函数执行失败,则这个缓冲区里的数据是未定义的,调用者不应该对这些数据做出任何假定。
但是,还是有人会这样做。
我曾经读过 Michael Kaplan 的一篇关于输出缓冲区的文章,在那篇文章中,用户要求,即使函数执行失败,函数也需要将输出缓冲区里的数据做出一定的设置后才返回。
为什么输出缓冲区在函数失败的时候一定不能做出任何修改,因为有很多应用程序会依赖这个行为:函数调用失败后,函数将不会对输出缓冲区做任何改动,即使并没有文档指明函数一定要支持这个行为特征。
下面是一个简化版本的例子代码,它会依赖输出缓冲区在函数调用失败后不会有任何改动。
>> 请移步至 topomel.com 以查看图片 <<
此代码片段首先定义一个默认的注册表键值,然后尝试打开一个”更好”的键,假设如果打开失败,hk 变量的内容将保持不变,因此将继续具有原始默认值。RegOpenKeyEx 函数的规范不能保证这种行为,但这并不能阻止人们依赖它。
这只是 Win32 为了兼容性而需要定期维持的各种滥用行为的一个简单示例。因为,毕竟,人们购买计算机是为了在计算机上运行程序。
“失败时输出缓冲区未定义”规则的一个重要例外是 COM 接口返回的输出缓冲区规则是,输出缓冲区始终被初始化,即使在失败时也是如此。这对于确保编组器不会崩溃是必要的。例如,IUnknown::QueryInterface 方法的最后一个参数必须在失败时设置为 NULL。
总结
到底要不要设置输出缓冲区,好像确实是一个需要权衡的问题。
如果代码库作者决定在函数执行失败的时候设置缓冲区,则必须在文档中明确指明此行为。
我的个人习惯是:不论函数是否执行成功,都会在客户提供的缓冲区设置一个合理值。
说到底,我看起来还是一个决定论者。
最后
Raymond Chen的《The Old New Thing》是我非常喜欢的博客之一,里面有很多关于Windows的小知识,对于广大Windows平台开发者来说,确实十分有帮助。
本文来自:《More undocumented behavior and the people who rely on it: Output buffers》
相关文章
- 使用OpenCV实现一个文档自动扫描仪
- Adobe Acrobat Pro DC 世界上最优秀的桌面版 PDF 文档创建 / 编辑 / 审查软件
- 实战 | 记一次Word文档网络钓鱼以及绕过火绒,电脑管家和Windows Defender
- CSS专题,熟练布局技巧,需知文档流
- Linux系统下文档管理的好帮手(linux文档管理软件)
- 探索Linux之旅:深入理解文档(linuxdoc)
- 如何创建适合移动设备的文档
- 解密 MongoDB 文档管理:文件目录排查尽在掌握(mongodb文件目录)
- MYSQL文档模板下载轻松规范你的数据库文档输出,提高工作效率(MYSQL下载文档模板)
- 使用XSL将XML文档中的CDATA注释输出为HTML文本
- jQueryEasyUIAPI中文文档-Spinner微调器使用