3.1.4.1.85 FAX_SetOutboundGroup (Opnum 52)

The fax client application calls the FAX_SetOutboundGroup (Opnum 52) method to set a new device list to an existing group. The name of the group to remove is specified using the lpwstrGroupName parameter. The value for lpwstrGroupName can be obtained using FAX_EnumOutboundGroups (section 3.1.4.1.26).

In response, the server MUST validate whether the client's fax user account has access to set the outbound routing groups. It MUST validate whether the dwSizeOfStruct field passed in pGroup is equal to the size of RPC_FAX_OUTBOUND_ROUTING_GROUPW (section 2.2.39) structure. On success, the server MUST modify its outbound routing groups as specified by the client.

 error_status_t FAX_SetOutboundGroup(
   [in] handle_t hFaxHandle,
   [in, ref] PRPC_FAX_OUTBOUND_ROUTING_GROUPW pGroup
 );

hFaxHandle: The RPC binding handle for this call. The client SHOULD reuse the RPC binding handle used as an input hBinding argument for the FAX_ConnectFaxServer (section 3.1.4.1.10) or FAX_ConnectionRefCount (section 3.1.4.1.11) method call used to connect to the fax server.

pGroup: A pointer to an RPC_FAX_OUTBOUND_ROUTING_GROUPW buffer to set.

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	The client's fax user account does not have the required FAX_ACCESS_MANAGE_CONFIG authorization for this operation.
ERROR_INVALID_PARAMETER 0x00000057	The parameter is incorrect. This error code is returned when any of the following conditions occur: § The dwSizeOfStruct member of the pGroup parameter is not equal to the correct size of the RPC_FAX_OUTBOUND_ROUTING_GROUPW. § The lpwstrGroupName member of pGroup is set to a NULL pointer value. § The lpdwDevices member of pGroup is set to NULL and the dwNumDevices member of the same pGroup is set to a value greater than zero. § The fax server tried to return FAX_ERR_NOT_SUPPORTED_ON_THIS_SKU but the client fax API version (FAX_API_VERSION_0, described in section 3.1.4.1.10) does not support this error code.
ERROR_BUFFER_OVERFLOW 0x0000006F	The length (excluding the terminating null character) of the character string pointed at by the lpwstrGroupName member of pGroup is longer than 128 characters.
ERROR_REGISTRY_CORRUPT 0x000003F7	The registry is corrupted. The structure of one of the files containing registry data is corrupted, or the system's memory image of the file is corrupted, or the file could not be recovered because the alternate copy or log was absent or corrupted.
FAX_ERR_NOT_SUPPORTED_ON_THIS_SKU 0x00001B63	The fax client module API version (described in section 3.1.4.1.10) is FAX_API_VERSION_1 or above, and the fax server is running on a version of the operating system that does not support the requested operation.<163>

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