IFaxServer::get_ServerMapiProfile

The IFaxServer::get_ServerMapiProfile method retrieves the ServerMapiProfile property for a FaxServer object. The ServerMapiProfile property is a null-terminated string that contains the MAPI user profile that the fax server uses for routing incoming fax transmissions.

Visual Basic Reference

HRESULT get_ServerMapiProfile(
  BSTR *pVal  // receives MAPI profile string
);

Parameters

pVal

[out] Pointer to a string that contains the MAPI user profile that the fax server uses for routing incoming fax transmissions. The fax server also uses the profile for sending delivery reports (DRs) and non-delivery reports (NDRs).

Return Values

Returns an HRESULT value indicating success or failure. If the method succeeds, it returns S_OK. Otherwise, it returns a COM-defined error code.

You should not check directly for success or failure. Use the COM SUCCEEDED and FAILED macros instead.

Remarks

The IFaxServer::get_ServerMapiProfile method allocates the memory required for the buffer pointed to by the retVal parameter. The client application must call the SysFreeString function to deallocate the resources associated with this parameter. For more information, see Enabling MAPI Functionality in a Fax Client Application and Freeing Fax Resources.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Unsupported.
  Header: Declared in faxcom.h.
  Import Library: Included as a resource in faxcom.dll.

See Also

Fax Service Client Application Programming Interface Overview, Fax Service Client API Interfaces, IFaxServer, IFaxServer::put_ServerMapiProfile, SysFreeString