wpclsQueryIconDataN
This class method is specific to version 3, or higher, of the OS/2 operating system. This class method allows the system to build the class default animation icon for a given class.
Syntax
_wpclsQueryIconDataN(somSelf, pIconInfo, ulcbIconInfo, ulIconIndex)
Parameters
- somSelf (M_WPFolder *) - input
- Pointer to the WPFolder class object.
- pIconInfo (PICONINFO) - input
- Pointer to the icon information.
- ulcbIconInfo (ULONG) - input
- Size of the buffer needed to store the ICONINFO data returned by this class object.
- ulIconIndex (ULONG) - input
- Animation icon index. This value must be 1.
Returns
- ulcbIconInfo (ULONG) - returns
- Size of the buffer needed to store the ICONINFO data returned by this class object.
Remarks
If NULLHANDLE is passed for the pIconInfo parameter, the caller is asking for the size of the ICONINFO buffer needed for this class usually for memory allocation purposes. Otherwise, the pIconInfo parameter can always be assumed to be large enough to accommodate the ICONINFO for this class.
Note that the ICONINFO structure allows you to specify the default icon in three different ways:
- An icon filename
- A module name and resource identifier
- A block of binary data
However, only one mechanism needs to be supported for any given class. For example, a caller cannot request one of the three formats by prefilling the ICONINFO structure.
How to Override
Workplace classes that wish to have a unique class default animation icon must override this method and fill out the appropriate fields within the ICONINFO structure. In addition, the correct size for the ICONINFO must always be returned.
Usage
This method may be called at any time. Typically, it would not be useful for another object class to make calls to this method.