CWBSO_DisplayObjAttr

Use the CWBSO_DisplayObjAttr API with this product.

Purpose

Displays the attributes window for an object. From this window, the user is allowed to view the object attributes and change attributes that are changeable.

Syntax

 
unsigned int CWB_ENTRY CWBSO_DisplayObjAttr(
                CWBSO_OBJ_HANDLE objectHandle,          
                HINSTANCE hInstance,                    
                int nCmdShow,                           
                HWND far* lphWnd ,                      
                CWBSO_ERR_HANDLE errorHandle);

Parameters

CWBSO_OBJ_HANDLE objectHandle - input: A handle to an object that was returned by a previous call to CWBSO_GetObjHandle or CWBSO_CopyObjHandle.
HINSTANCE hInstance - input: The program instance passed to the calling program's WinMain procedure.
int nCmdShow - input: The show window parameter passed to the calling program's WinMain procedure. Alternatively, any of the constants defined for the Windows API ShowWindow() may be used.
HWND far* lphWnd - output: A long pointer to a window handle. This will be set to the handle of the window in which the object attributes are displayed.
CWBSO_ERR_HANDLE errorHandle - input: A handle to an error object. If an error occurs that there is error text for, this handle may be used to retrieve the error message and message help.

Return Codes

The following list shows common return values.

CWBSO_NO_ERROR: No error occurred.
CWBSO_BAD_OBJ_HANDLE: The object handle that is specified is not valid.
CWBSO_BAD_ERR_HANDLE: The error handle that is specified is not valid.
CWBSO_DISPLAY_FAILED: The window could not be created.
CWBSO_LOW_MEMORY: Not enough memory is available for the request.
CWBSO_ERROR_OCCURRED: An error occurred. Use error handle for more information.

Usage

CWBSO_GetObjHandle or CWBSO_CopyObjHandle must be called prior to calling this API. The object handle that is returned by CWBSO_GetObjHandle or CWBSO_CopyObjHandle must be passed as input to this API. CWBSO_CreateErrorHandle must be called prior to calling this API. The error handle that is returned by CWBSO_CreateErrorHandle must be passed as input to this API. Your program must have a message loop to receive the Windows messages that will be sent during the use of the system object attributes window.

This API only applies to the following list types: Jobs, Messages, Printers, Printer Output, and Spooled Files.