INFO: GetDescendantWindow - bOnlyPerm Parameter Incorrect (121665)



The information in this article applies to:

  • Microsoft Foundation Classes (MFC), when used with:
    • Microsoft Visual C++ for Windows, 16-bit edition 1.0
    • Microsoft Visual C++ for Windows, 16-bit edition 1.5
    • Microsoft Visual C++ for Windows, 16-bit edition 1.51
    • Microsoft Visual C++, 32-bit Editions 1.0
    • Microsoft Visual C++, 32-bit Editions 2.0
    • Microsoft Visual C++, 32-bit Editions 2.1
    • Microsoft Visual C++, 32-bit Editions 2.2

This article was previously published under Q121665

SUMMARY

The documentation for CWnd::GetDescendantWindow incorrectly states:

bOnlyPerm - Specifies whether the window to be returned can be temporary. If TRUE, the function can return a temporary window; if FALSE, only a permanent window can be returned. For more information on temporary windows see Technical Note 3 under MFC in Books Online.

The behavior, as the parameter's name implies, is the opposite of how it is documented. The documentation for the bOnlyPerm parameter should state:

bOnlyPerm - Specifies whether the window to be returned must be permanent. If TRUE, the function will return a pointer to a permanent CWnd object or NULL; if FALSE, the function can return a pointer to a temporary CWnd object. For more information on temporary windows see MFC Technical Note #3.

NOTE: This problem was fixed in Microsoft Visual C++, 32-bit Edition, version 4.0. The 4.0 Books On-Line entry for CWnd::GetDescendantWindow() correctly documents the meanings of the various bOnlyPerm parameter values.

Modification Type:MajorLast Reviewed:12/2/2003
Keywords:kbBug kbdocerr kbdocfix KbUIDesign kbVC400fix KB121665