3.1.4.1.71 FAX_RemoveOutboundGroup (Opnum 53)

The fax client application calls the FAX_RemoveOutboundGroup (Opnum 53) method to remove an existing outbound routing group from the fax server. 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).<149>

In response, the server MUST validate that the lpwstrGroupName does not specify the special routing group called "<All Devices>", because this routing group cannot be removed. The client's fax user account MUST have access to manage configuration on the server. The server MUST also confirm that the group is NOT being used in a rule.

On success, the server MUST remove the specified outbound routing group.

 error_status_t FAX_RemoveOutboundGroup(
   [in] handle_t hFaxHandle,
   [in, string, ref] LPCWSTR lpwstrGroupName
 );

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.

lpwstrGroupName: A pointer to a null-terminated string that uniquely identifies an existing group name. The group name is expected to be case-insensitive.

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_ACCESS_MANAGE_CONFIG access rights.

ERROR_INVALID_PARAMETER

0x00000057

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 the section 3.1.4.1.10) does not support this error code.

ERROR_BUFFER_OVERFLOW

0x0000006F

The group name specified by the lpwstrGroupName argument (excluding the length of the terminating null character) is longer than 128 characters.

ERROR_REGISTRY_CORRUPT

0x000003F7

The fax server cannot access the local machine's fax routing group information in the registry. The registry could be corrupt.

ERROR_INVALID_OPERATION

0x000010DD

The lpwstrGroupName parameter specifies the special routing group "<All Devices>".

FAX_ERR_GROUP_NOT_FOUND

0x000001B5A

The group specified by the lpwstrGroupName argument cannot be found.

FAX_ERR_GROUP_IN_USE

0x00001B5C

The fax server cannot remove the outbound routing group identified by lpwstrGroupName. The outbound routing group is in use by one or more outbound routing rules.

FAX_ERR_NOT_SUPPORTED_ON_THIS_SKU

0x00001B63

The fax client module API version (described in the 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.<150>

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