IFsrmObject::Description property

Retrieves or sets the description of the object.

This property is read/write.

Syntax


HRESULT put_Description(
  [in]  BSTR description
);

HRESULT get_Description(
  [out] BSTR *description
);

Property value

A description of the object. The description is limited to 4,000 characters and cannot contain commas, single quotes, double quotes, or vertical bars.

Error codes

The method returns the following return values.

S_OK

Success.

E_INVALIDARG

The description parameter contains non-valid characters or is NULL.

FSRM_E_OUT_OF_RANGE

The description is too long.

Examples

For an example, see Using Templates to Define File Screens.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008

Header

Fsrm.h (include FsrmQuota.h, FsrmReports.h, or FsrmScreen.h)

DLL

SrmSvc.dll

IID

IID_IFsrmObject is defined as:
  • 22bcef93-4a3f-4183-89f9-2f8b8a628aee
  • 22bcef93-4a3f-4183-89f9-2f8b8a628aee

See also

IFsrmObject

 

 

Show: