3.2.4.2.11.5 AdminEmail (get) (Opnum 11)

  • Article

The AdminEmail (get) retrieves the administrator email address, which is used for the Admin Email macro that the File Server Resource Manager Protocol is configured to use, and returns S_OK upon successful completion. The format of the email address has to be as specified in [RFC5322].

 [propget, id(FSRM_PROPERTY(FSRM_DISPID_SETTING | 0x03))] HRESULT AdminEmail(
   [out, retval] BSTR* adminEmail
 );

adminEmail: Pointer to a variable that upon completion contains the administrator email address that the File Server Resource Manager Protocol is configured to use.

Return Values: The method MUST return zero on success, or a nonzero error code on failure.

Return value/code

Description

0x80070057

E_INVALIDARG

The adminEmail parameter is NULL.

Upon receiving this message, the server MUST validate parameters:

  • Verify that adminEmail is not NULL.

If any validation fails, the server MUST terminate processing and return a nonzero error code.

The server MUST set adminEmail to the administrator email address that the File Server Resource Manager Protocol is configured to use.