IPXV_Inst::PathToName Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
Line 8: Line 8:
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT PathToName([in]                    LPWSTR        sPath,
+
<pre class="brush:cpp;gutter:false">HRESULT PathToName([in]                    LPWSTR        Path,
                   [in, defaultvalue(0)]  VARIANT_BOOL  bDIPath,
+
                   [in, defaultvalue(0)]  VARIANT_BOOL  DIPath,
                   [in, defaultvalue("")]  BSTR          sFSName,
+
                   [in, defaultvalue("")]  BSTR          FSName,
                   [in, defaultvalue(-1)]  VARIANT_BOOL  bAllowAuth,
+
                   [in, defaultvalue(-1)]  VARIANT_BOOL  AllowAuth,
                   [in, defaultvalue(0)]  HANDLE_T      nWndParent,
+
                   [in, defaultvalue(0)]  HANDLE_T      hWndParent,
                   [out, retval]          IAFS_Name**  pRes);</pre>
+
                   [out, retval]          IAFS_Name**  Res);</pre>
  
 
== Parameters ==
 
== Parameters ==
;sPath
+
;Path
 
:[in]  The string that contains path to the resource.
 
:[in]  The string that contains path to the resource.
;bDIPath
+
;DIPath
 
:[in, defaultvalue(0)]  The optional flag, indicates should the input path be interpreted as device-independed.
 
:[in, defaultvalue(0)]  The optional flag, indicates should the input path be interpreted as device-independed.
;sFSName
+
;FSName
 
:[in, defaultvalue("")]  The optional value, may contain the name of source file system. If not specified the function will try to choose file system by input path.
 
:[in, defaultvalue("")]  The optional value, may contain the name of source file system. If not specified the function will try to choose file system by input path.
;bAllowAuth
+
;AllowAuth
 
:[in, defaultvalue(-1)]  The optional flag to allow/prevent the interactive authentication.
 
:[in, defaultvalue(-1)]  The optional flag to allow/prevent the interactive authentication.
;nWndParent
+
;hWndParent
 
:[in, defaultvalue(0)]  Specifies handle of parent window for any possible interactions inside function. The value is optional and you may pass NULL there.
 
:[in, defaultvalue(0)]  Specifies handle of parent window for any possible interactions inside function. The value is optional and you may pass NULL there.
;pRes
+
;Res
 
:[out, retval]  Returns pointer to [[PXV:IAFS_Name|IAFS_Name]] object.
 
:[out, retval]  Returns pointer to [[PXV:IAFS_Name|IAFS_Name]] object.
  

Revision as of 07:32, 12 June 2015


Resolves the input path to the IAFS_Name object. The function will automatically bind to source file-system and if authentication is required - perform UI for authentication.

Syntax

HRESULT PathToName([in]                    LPWSTR        Path,
                   [in, defaultvalue(0)]   VARIANT_BOOL  DIPath,
                   [in, defaultvalue("")]  BSTR          FSName,
                   [in, defaultvalue(-1)]  VARIANT_BOOL  AllowAuth,
                   [in, defaultvalue(0)]   HANDLE_T      hWndParent,
                   [out, retval]           IAFS_Name**   Res);

Parameters

Path
[in] The string that contains path to the resource.
DIPath
[in, defaultvalue(0)] The optional flag, indicates should the input path be interpreted as device-independed.
FSName
[in, defaultvalue("")] The optional value, may contain the name of source file system. If not specified the function will try to choose file system by input path.
AllowAuth
[in, defaultvalue(-1)] The optional flag to allow/prevent the interactive authentication.
hWndParent
[in, defaultvalue(0)] Specifies handle of parent window for any possible interactions inside function. The value is optional and you may pass NULL there.
Res
[out, retval] Returns pointer to IAFS_Name object.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

IPXV_Inst