Skip to content
pCon.configurator onlineDocumentation
Esc
↑↓navigate↵open⌘Jpreview
On this page

getPreferredIconSize

Synopsis

int getPreferredIconSize(SessionId sessionId)
throws CatalogServiceFault;

See also: SessionId, CatalogServiceFault

The getPreferredIconSize operation returns the preferred icon size assumed by the Online Configurator. The operation returns zero if the preferred icon size has not been previously set by an successful invocation of the setPreferredIconSize operation. Otherwise, the operation returns the value of the size argument from the last successful invocation of the setPreferredIconSize operation for the same session.

A CatalogServiceFault is returned if any of the following conditions occurs:

  • The sessionId parameter is not a valid string representation of an UUID or does not represent an open session.