IFsrmPropertyBag::AddMessage method

Adds an error message to the bag.

Syntax


HRESULT AddMessage(
  [in] BSTR message
);

Parameters

message [in]

The error message to add to the bag. The message is limited to 4096 characters (the message is truncated if longer than 4096 characters).

Return value

The method returns the following return values.

S_OK

Success

Remarks

You can add only one message to the bag. The message is written to the error log, if enabled.

If any of the following implementations returns an error code, FSRM automatically adds a message (which does not count against the one-message limit) that includes the error code and associated message string:

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008 R2

Header

FsrmPipeline.h

DLL

SrmSvc.dll

IID

IID_IFsrmPropertyBag is defined as 774589d1-d300-4f7a-9a24-f7b766800250

See also

IFsrmPropertyBag
IFsrmPropertyBag::Messages

 

 

Show: