RefreshClients Method

Description

Instructs a connected sink client to refresh its content.

Return Type

None

Syntax

object.RefreshClients eDepth, sWhereHint, vContextData

The RefreshClients Method syntax has these parts:

Part	Description
object	An expression evaluating to an object of type McDataNodes.
eDepth	Required. A mcdataNodesRefresh enumeration, as described in settings. Specifies 'what' client should refresh. Contents and Selection, Current are examples of what can be refreshed. Also specifies 'how' client should refresh. Some clients may maintain dirty state information and may only normally refresh changed information. This parameter may be used to override or set the depth the client's refresh.
sWhereHint	Required. A String value. All Sinked clients will receive a notification. A value may be sent to specify that only certain clients need to act. A nullstring identifies that all clients be refreshed.
vContextData	Required. A Variant value. Extra data may be transmitted to the clients. This data may be specific each particular client.

Settings

The settings for eDepth are:

Constant		Value	Description
	mcdatnrc_None	0	Perform default logic.
	mcdatnrc_Current	1	The Current reference should be retrieved.
	mcdatnrc_Selection	2	The Selection reference should be retrieved.
	mcdatnrc_SelectionWithCurrent	3	Both the Selection reference and Current reference should be retrieved.
	mcdatnrc_IgnoreOutOfSyncState	65536	Ignore any object state tracking and retrieve state of contents related to this object.
	mcdatnrc_RebuildAll	131072	To rebuild all UI or cached contents.
	mcdatnrc_IgnoreDirtyState	262144	Abandon any edits to any content related to the object.

Remarks

This function may be used to control a user-interface or any object connected to this object. The client
would normally update its user-interface or cached data upon notification.