Description property

This property is implemented by the following interfaces. Click one of the links below to jump to the description of the property as it pertains to that interface.

IERUCalendarEventPage
IERUCalendarPage

IERUCustomRole

IERUDashboardPage
IERUDBPage
IERUDiscussionPage

IERUExtension

IERUFolderPage
IERUInboxPage
IERUMailPage
IERUNotePage
IERUProjectSchedulePage
IERUProjectTaskPage

IERUProvisioningGroup
IERURoom
IERUSiteRoom
IERUSynchronousEventHandler

IERUTopicPage

 

 

Description property

Returns an IERURichText interface pointer for the description of the page.

Syntax


C++

HRESULT get_Description(
   
IERURichText** ppDescription)

Scripting languages

Description = Object.Description

Remarks


For IERUDiscussionPage, this property is only used for backward compatibility purposes. Beginning with v4.0, there is no Description in the discussion page. The user can still see the existing description from Discussion Pages created using older versions, but can't modify or delete the old descriptions. Discussion Pages created using v4.0 or newer versions of eRoom will return NULL (or Nothing) for this property.

 

Go to Top

 

 

Description property

Returns or sets an IERURichText interface pointer for the description of the page.

Syntax


C++

HRESULT get_Description(
   
IERURichText** ppDescription)

HRESULT put_Description(
   
IERURichText MyDescription)

Scripting languages

Description = Object.Description

Object.Description = Description

Remarks


For IERUDiscussionPage, this property is only used for backward compatibility purposes. Beginning with v4.0, there is no Description in the discussion page. The user can still see the existing description from Discussion Pages created using older versions, but can't modify or delete the old descriptions. Discussion Pages created using v4.0 or newer versions of eRoom will return NULL (or Nothing) for this property.

 

Go to Top

 

 

Description property

For IERURoom, sets or returns the eRoom description that appears in the Directory of eRooms listing.

For IERUCustomRole, sets or returns the plain text description of a custom role.

For IERUSynchronousEventHandler, sets or returns the plain text description of the synchronous event handler.

For IERUProvisioningGroup, sets or returns the plain text description of the provisioning group.

For IERUSiteRoom, returns but does not set the plain text description of the custom command or viewer.

 

Syntax


C++

HRESULT get_Description(BSTR* pDescription)

HRESULT put_Description(BSTR MyDescription)

Scripting languages

String = Object.Description

Object.Description = String

Remarks


The description must not exceed 32K characters.

Go to Top

 

 

Home

Applies to

IERUCustomRole

IERUProvisioningGroup

IERURoom

IERUSiteRoom

IERUSynchronousEventHandler

Description property

Returns the specified language-specific description of this extension. A LANGID of 0 specifies the thread's current language.

 

Syntax


C++

HRESULT get_Description(
   
LONG LANGID,
   BSTR*
pDescription)

Scripting languages

Description = Object.Description(LanguageID as Long)

 

Go to Top

Home

Applies to

IERUExtension