L_DispContainerSetProperties

#include "ltivw.h"

L_LTIVW_API L_INT L_DispContainerSetProperties (hCon, pDispContainerProp, uFlags)

HDISPCONTAINER hCon;	/* handle to the container */
pDISPCONTAINERPROPERTIES * pDispContainerProp;	/* pointer to a container options structure */
L_UINT uFlags;	/* reserved for future use */

This function sets the properties of the container.

Parameter	Description
hCon	Handle to the container.
pDispContainerProp	Pointer to a DISPCONTAINERPROPERTIES structure that contains the options for controlling the behavior of the container.
uFlags	Reserved for future use. Pass 0.

Returns

SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

This function automatically updates the container window, so the user does not have to redraw the window.

Before calling L_DispContainerSetProperties apply the following:

declare a variable of type DISPCONTAINERPROPERTIES.
set DISPCONTAINERPROPERTIES.uStructSize to sizeof(DISPCONTAINERPROPERTIES)
set DISPCONTAINERPROPERTIES.uMask to indicate the properties to be set (that is, which members of the structure contain valid information)
specify the new property values in the appropriate members.
pass a pointer to the DISPCONTAINERPROPERTIES structure to L_DispContainerSetProperties as the pDispContainerProp parameter.

To get the current properties set for a container, call L_DispContainerGetProperties.

For more information on the actual properties that can be set, refer to the DISPCONTAINERPROPERTIES structure.

If this function is not called before using the container, the following default container properties are used. For information on these default values, refer to DISPCONTAINERPROPERTIES.

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:	L_DispContainerCreate, L_DispContainerDestroy, L_DispContainerGetProperties, L_DispContainerGetHandle, L_DispContainerGetWindowHandle
Topics:	Using the Image Viewer
	Image Viewer Functions: Using the Image Viewer

Example

For an example, refer to L_DispContainerCreate.