<div class="content" name="FaxObs_GetQueueFileName" uuid="21d0c234-8dca-4f96-b7ea-2bdce029ee00"><p>The client calls <b>FaxObs_GetQueueFileName (Opnum 6)</b> to
obtain from the server the name of a new file located in the fax <b>server
queue directory</b>. The client can copy to this file the fax data to be
transmitted and submit the file name to <b>FaxObs_SendDocument</b> (section
<a href="21b87199-d4e7-472c-9190-90c6bb16d947" data-linktype="relative-path">3.1.4.2.7</a>).</p><p>The client SHOULD set the <i>FileNameSize</i> parameter to a
value of 255 characters. If the client sets <i>FileNameSize</i> to a value
exceeding 255 characters, the server SHOULD NOT write more than 255 characters,
including the terminating null character, to the <i>FileName</i> output
parameter.</p><p>The client&#39;s fax user account SHOULD have write file access
under the fax <b>server queue directory</b>.<a id="Appendix_A_Target_191"></a><a aria-label="Product behavior note 191" href="056171e7-80bc-45ff-8107-66ba3abb2023#Appendix_A_191" data-linktype="relative-path">&lt;191&gt;</a></p><p>In response, the fax server MUST create a new and unique
file within the <a href="46aba9c4-ebb1-4b10-86ac-4bb3025657b9#gt_0c5e7185-40c3-4e58-a8ac-7626ed078235" data-linktype="relative-path">fax queue</a>
directory and return the name of this file, including the server&#39;s local
directory path to the file. The file name MUST have a &#34;.tif&#34;
extension.</p><p>The client SHOULD construct the fully qualified <a href="46aba9c4-ebb1-4b10-86ac-4bb3025657b9#gt_c9507dca-291d-4fd6-9cba-a9ee7da8c908" data-linktype="relative-path">UNC</a> path to the file
created by the server, by appending the character string returned by this
method in <i>FileName</i> to the server&#39;s <a href="46aba9c4-ebb1-4b10-86ac-4bb3025657b9#gt_1769aec9-237e-44ed-9014-1abb3ec6de6e" data-linktype="relative-path">fully qualified domain name
(FQDN)</a> followed by &#34;\fax$\queue\&#34;, where &#34;fax$&#34; is the
name of the <a href="46aba9c4-ebb1-4b10-86ac-4bb3025657b9#gt_a49a79ea-dac7-4016-9a84-cf87161db7e3" data-linktype="relative-path">share</a>
pointing to the local fax queue directory on the server. The server MUST
provide the &#34;fax$&#34; share upon the fax server installation.</p><dl>
<dd>
<div><pre> error_status_t FaxObs_GetQueueFileName(
   [in] handle_t hBinding,
   [in, out, unique, size_is(FileNameSize)] 
     LPWSTR FileName,
   [in] DWORD FileNameSize
 );
</pre></div>
</dd></dl><p><b>hBinding: </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>FaxObs_ConnectionRefCount</b> (section <a href="9430f7e2-d21d-4a38-a859-367b74f68a1a" data-linktype="relative-path">3.1.4.2.2</a>) method call
used to connect to the fax server.</p><p><b>FileName: </b>A buffer that MUST be allocated by
the client to hold <i>FileNameSize</i> characters. On successful return from
this call the server MUST write to this buffer a null-terminated character
string containing the path name, including file name and extension, for a new
unique file name within the fax <b>server queue directory</b>.<a id="Appendix_A_Target_192"></a><a aria-label="Product behavior note 192" href="056171e7-80bc-45ff-8107-66ba3abb2023#Appendix_A_192" data-linktype="relative-path">&lt;192&gt;</a></p><p><b>FileNameSize: </b>A <b>DWORD</b> (<a href="../ms-dtyp/cca27429-5689-4a16-b2b4-9325d93e4ba2" data-linktype="relative-path">[MS-DTYP]</a>
section <a href="../ms-dtyp/262627d8-3418-4627-9218-4ffe110850b2" data-linktype="relative-path">2.2.9</a>)
value that specifies the size, in characters, of the <i>FileName</i> buffer.<a id="Appendix_A_Target_193"></a><a aria-label="Product behavior note 193" href="056171e7-80bc-45ff-8107-66ba3abb2023#Appendix_A_193" data-linktype="relative-path">&lt;193&gt;</a></p><p><b>Return Values: </b>This method MUST return
0x00000000 (ERROR_SUCCESS) for success; otherwise, it MUST return one of the
fax-specific errors that are defined in section <a href="cbe6c4fb-4dda-4f6c-9701-0d490ba0d105" data-linktype="relative-path">2.2.52</a> or one of the other
standard errors defined in <a href="../ms-erref/1bc92ddf-b79e-413c-bbaa-99a5281a6c90" data-linktype="relative-path">[MS-ERREF]</a>
section <a href="../ms-erref/18d8fbe8-a967-4f1c-ae50-99ca8e491d2d" data-linktype="relative-path">2.2</a>.
There are no predefined specific error codes to be returned by this method.</p><p><b>Exceptions Thrown:</b> No exceptions are thrown
except those that are thrown by the underlying <a href="46aba9c4-ebb1-4b10-86ac-4bb3025657b9#gt_8a7f6700-8311-45bc-af10-82e10accd331" data-linktype="relative-path">RPC</a> protocol, <a href="../ms-rpce/290c38b1-92fe-4229-91e6-4fc376610c15" data-linktype="relative-path">[MS-RPCE]</a>.</p></div>