LImageViewerCell::GetTitlebarProperties

#include "ltwrappr.h"

L_INT LImageViewerCell::GetTitlebarProperties(pDispContainerTitlebarProps, uFlags)

pDISPCONTAINERTITLEBARPROPS pDispContainerTitlebarProps;

/* pointer to the DISPCONTAINERTITLEBARPROPS structure */

L_UINT uFlags;

/* reserved for future use */

Retrieves the title bar properties.

Parameter

Description

pDispContainerTitlebarProps

Retrieves the title bar properties.

uFlags

Reserved for future use. Pass 0.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

Before calling LImageViewerCell::GetTitlebarProperties the user should:

1.

Declare a variable of type DISPCONTAINERTITLEBARPROPS.

2.

Set the DISPCONTAINERTITLEBARPROPS.uStructSize member to the value of sizeof(DISPCONTAINERTITLEBARPROPS).

3.

Set the DISPCONTAINERTITLEBARPROPS.uMask member value to indicate what the members will be updated with the current values.

4.

Pass a pointer to the DISPCONTAINERTITLEBARPROPS structure to LImageViewerCell::GetTitlebarProperties as the pDispContainerTitlebarProps parameter.

To change the title bar properties, call the LImageViewerCell::GetTitlebarProperties function.

For more information on the available title bar properties, refer to the DISPCONTAINERTITLEBARPROPS structure.

Required DLLs and Libraries

LTIVW

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions:

LImageViewer::Create, LImageViewer::Destroy, LImageViewerCell::IsTitlebarIconChecked, LImageViewerCell::GetIconProperties, LImageViewerCell::IsTitlebarEnabled, LImageViewerCell::SetIconProperties, LImageViewerCell::SetTitlebarProperties, LImageViewerCell::ShowTitlebar, LImageViewerCell::CheckTitlebarIcon

Topics:

Image Viewer Functions: The Title Bar Feature

 

The Title Bar Feature

Example

For an example, refer to LImageViewerCell::ShowTitlebar.