3.1.4.2.30 FaxObs_GetMapiProfiles (Opnum 28)

The FaxObs_GetMapiProfiles (Opnum 28) method is called by the client to retrieve the names of the current MAPI profiles set for the fax server. For more information about MAPI profiles, see [MSDN-MAPIPRF].

On success, the server MUST allocate memory for, and return the list of, the current MAPI profile names. They MUST be formatted as a sequence of null-terminated character strings, with the sequence terminated by a single empty, null-terminated character string.

The client SHOULD free the buffer.

 error_status_t FaxObs_GetMapiProfiles(
   [in] handle_t hBinding,
   [in, out, unique, size_is(,*BufferSize)] 
     LPBYTE* MapiProfiles,
   [in, out] LPDWORD BufferSize
 );

hBinding: A handle that is provided by the client RPC layer when the RPC call is made.

MapiProfiles: A pointer to the address of the returned buffer. This buffer contains a sequence of null-terminated character strings; each of these strings contains the name of a MAPI profile. The sequence is terminated by an empty null-terminated character string.

BufferSize: Pointer to a DWORD ([MS-DTYP] section 2.2.9) variable that receives the size, in bytes, of the data returned in the MapiProfiles character strings sequence.

Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise, it MUST return one of the following error codes, one of the fax-specific errors that are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF] section 2.2.

Return value/code	Description
ERROR_ACCESS_DENIED 0x00000005	Access is denied. The client's fax user account does not have the FAX_CONFIG_QUERY access rights.
ERROR_INVALID_PARAMETER 0x00000057	The parameter is incorrect. This error is returned if the MapiProfiles or the BufferSize parameters are set to NULL pointer values. <212>

Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying RPC protocol, [MS-RPCE].