<div class="content"><p> </p><p>The <b>FAX_AddOutboundRule (Opnum 56)</b> method is called
by the client to add a new outbound rule for the specified outbound group to
the fax server’s rules map. The value for the <i>dwDeviceId</i> parameter can
be obtained using the <b>FAX_EnumPorts</b> (section <span><a href="7143a58b-d7c5-4353-8857-39c7f708e778" data-linktype="relative-path">3.1.4.1.28</a></span>) method
or the <b>FAX_EnumPortsEx</b> (section <span><a href="f26e50ab-ed8e-448d-928c-1820f4a42918" data-linktype="relative-path">3.1.4.1.29</a></span>) method.</p><p>In response, if bUseGroup is <b>TRUE</b>, the server MUST
validate that the group name is valid; if bUseGroup is <b>FALSE</b>, the server
MUST validate that the device ID is for a valid device. The server MUST
validate that the client&#39;s fax user account has access to add an outbound <span><a href="46aba9c4-ebb1-4b10-86ac-4bb3025657b9#gt_e3969a6a-4722-476e-9a36-bb63311ae950" data-linktype="relative-path">routing
rule</a></span>.</p><p>On success, the server MUST add an outbound rule to the fax
server.</p><dl>
<dd>
<div><pre> error_status_t FAX_AddOutboundRule(
   [in] handle_t hFaxHandle,
   [in] DWORD dwAreaCode,
   [in] DWORD dwCountryCode,
   [in] DWORD dwDeviceId,
   [in, string, unique] LPCWSTR lpwstrGroupName,
   [in] BOOL bUseGroup
 );
</pre></div>
</dd></dl><p><b>hFaxHandle: </b>The RPC binding handle for this
call. The client SHOULD reuse the RPC binding handle used as an input <i>hBinding</i>
argument for the <b>FAX_ConnectFaxServer</b> (section <span><a href="5cbfd38d-7a14-4560-ad24-9ed78f19a3bb" data-linktype="relative-path">3.1.4.1.10</a></span>) or <b>FAX_ConnectionRefCount</b>
(section <span><a href="a92941ac-bd07-4a71-af85-c2c157c97cf9" data-linktype="relative-path">3.1.4.1.11</a></span>) method
call used to connect to the fax server.</p><p><b>dwAreaCode: </b>The area code of the rule. A value
of zero indicates the special any-area value ROUTING_RULE_AREA_CODE_ANY. The
combination of the <i>dwAreaCode</i> and <i>dwCountryCode</i> parameters is a
unique key.</p><p><b>dwCountryCode: </b>The country/region code of the
rule. The value of this argument MUST NOT be zero. A value of zero indicates
the special any-country, any-region value ROUTING_RULE_COUNTRY_CODE_ANY, which
is not valid for this argument. The combination of <i>dwAreaCode</i> and <i>dwCountryCode</i>
is a unique key.</p><p><b>dwDeviceId: </b>The destination device of the
rule. This value is valid only if the <i>bUseGroup</i> parameter is <b>FALSE</b>.
The value of <i>dwDeviceId</i> MUST be greater than zero.</p><p><b>lpwstrGroupName: </b>The destination group of the
rule. This value is valid only if <i>bUseGroup</i> is <b>TRUE</b>.</p><p><b>bUseGroup: </b>A Boolean value that specifies
whether the group SHOULD be used as the destination.</p><p><b>Return Values: </b>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 <span><a href="cbe6c4fb-4dda-4f6c-9701-0d490ba0d105" data-linktype="relative-path">2.2.52</a></span>, or one of
the other standard errors defined in <span><a href="../ms-erref/1bc92ddf-b79e-413c-bbaa-99a5281a6c90" data-linktype="relative-path">[MS-ERREF]</a></span>
section <span><a href="../ms-erref/18d8fbe8-a967-4f1c-ae50-99ca8e491d2d" data-linktype="relative-path">2.2</a></span>.</p><dl>
<dd>
<table><thead>
  <tr>
   <th>
   <p>Return value/code</p>
   </th>
   <th>
   <p>Description</p>
   </th>
  </tr>
 </thead><tbody><tr>
  <td>
  <p>ERROR_ACCESS_DENIED</p>
  <p>0x00000005</p>
  </td>
  <td>
  <p>Access is denied. The client&#39;s fax user account does
  not have authorization required for this call (FAX_ACCESS_MANAGE_CONFIG).</p>
  </td>
 </tr><tr>
  <td>
  <p>ERROR_BAD_UNIT</p>
  <p>0x00000014</p>
  </td>
  <td>
  <p>The system cannot find the device specified by the <i>dwDeviceId</i>
  argument.</p>
  </td>
 </tr><tr>
  <td>
  <p>ERROR_GEN_FAILURE</p>
  <p>0x0000001F</p>
  </td>
  <td>
  <p>The fax server encountered an exception while
  processing the character string specified by the <i>lpwstrGroupName</i>
  argument.</p>
  </td>
 </tr><tr>
  <td>
  <p>ERROR_INVALID_PARAMETER</p>
  <p>0x00000057</p>
  </td>
  <td>
  <p>The parameter is incorrect. This error code is
  returned when any of the following conditions are met:</p>
  <p><span>§<span>  
  </span></span>The country code specified with the <i>dwCountryCode</i>
  argument is ROUTING_RULE_COUNTRY_CODE_ANY (not a valid rule dialing
  location).</p>
  <p><span>§<span>  
  </span></span>The <i>lpwstrGroupName</i> argument value is NULL.</p>
  <p><span>§<span>  
  </span></span>The value of the <i>dwDeviceId</i> argument is 0.</p>
  <p><span>§<span>  
  </span></span>The fax server needs 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.</p>
  </td>
 </tr><tr>
  <td>
  <p>ERROR_BUFFER_OVERFLOW</p>
  <p>0x0000006F</p>
  </td>
  <td>
  <p>The destination group of the rule specified by the <i>lpwstrGroupName</i>
  argument is longer than the maximum supported value of 128 characters
  (excluding the terminating null character).</p>
  </td>
 </tr><tr>
  <td>
  <p>ERROR_REGISTRY_CORRUPT</p>
  <p>0x000003F7</p>
  </td>
  <td>
  <p>The <span><a href="46aba9c4-ebb1-4b10-86ac-4bb3025657b9#gt_2d67ea57-10e6-422f-985e-694834945a02" data-linktype="relative-path">registry</a></span> is
  corrupted. The structure of one of the files containing registry data is
  corrupted, or the system&#39;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.</p>
  </td>
 </tr><tr>
  <td>
  <p>FAX_ERR_BAD_GROUP_CONFIGURATION</p>
  <p>0x00001B5B</p>
  </td>
  <td>
  <p>The fax server encountered an outbound <span><a href="46aba9c4-ebb1-4b10-86ac-4bb3025657b9#gt_20b15ad8-82b1-47ef-a494-561c9cdee7fa" data-linktype="relative-path">routing
  group</a></span> with a bad configuration, or the group device list is empty;
  the status for the new rule object created by the server based on the
  specified dialing location and device ID is
  FAX_RULE_STATUS_ALL_GROUP_DEV_NOT_VALID or FAX_RULE_STATUS_EMPTY_GROUP.</p>
  </td>
 </tr><tr>
  <td>
  <p>FAX_ERR_NOT_SUPPORTED_ON_THIS_SKU</p>
  <p>0x00001B63</p>
  </td>
  <td>
  <p>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.<a id="Appendix_A_Target_69"></a><a aria-label="Product behavior note 69" href="056171e7-80bc-45ff-8107-66ba3abb2023#Appendix_A_69" data-linktype="relative-path">&lt;69&gt;</a></p>
  </td>
 </tr></tbody></table>
</dd></dl><p><b>Exceptions Thrown: </b>No exceptions are thrown
except those that are thrown by the underlying <span><a href="46aba9c4-ebb1-4b10-86ac-4bb3025657b9#gt_8a7f6700-8311-45bc-af10-82e10accd331" data-linktype="relative-path">RPC</a></span> protocol <span><a href="../ms-rpce/290c38b1-92fe-4229-91e6-4fc376610c15" data-linktype="relative-path">[MS-RPCE]</a></span>.</p></div>