IPXV_Inst::PathToName Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 6: Line 6:
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Resolves the input path to the [[PXV:IAFS_Name|IAFS_Name]] object. The function will automatically bind to source file-system and if authentication is required - perform UI for authentication.
  
 
== Syntax ==
 
== Syntax ==
Line 18: Line 18:
 
== Parameters ==
 
== Parameters ==
 
;pPath
 
;pPath
:[in]  Value of LPWSTR.
+
:[in]  The string that contains path to the resource.
 
;bDIPath
 
;bDIPath
:[in, defaultvalue(0)]  Value of VARIANT_BOOL.
+
:[in, defaultvalue(0)]  The optional flag, indicates should the input path be interpreted as device-independed.
 
;pFSName
 
;pFSName
:[in, defaultvalue("")]  Value of BSTR.
+
:[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
 
;bAllowAuth
:[in, defaultvalue(-1)]  Value of VARIANT_BOOL.
+
:[in, defaultvalue(-1)]  The optional flag to allow/prevent the interactive authentication.
 
;hWndParent
 
;hWndParent
:[in, defaultvalue(0)]  Value of HANDLE_T.
+
:[in, defaultvalue(0)]  Specifies handle of parent window for any possible interactions inside function. The value is optional and you may pass NULL there.
 
;ppRes
 
;ppRes
:[out, retval]  Pointer to [[PXV:IAFS_Name|IAFS_Name]].
+
:[out, retval]  Returns pointer to [[PXV:IAFS_Name|IAFS_Name]] object.
  
 
== Return Value ==
 
== Return Value ==

Revision as of 17:47, 25 May 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        pPath,
                   [in, defaultvalue(0)]   VARIANT_BOOL  bDIPath,
                   [in, defaultvalue("")]  BSTR          pFSName,
                   [in, defaultvalue(-1)]  VARIANT_BOOL  bAllowAuth,
                   [in, defaultvalue(0)]   HANDLE_T      hWndParent,
                   [out, retval]           IAFS_Name**   ppRes);

Parameters

pPath
[in] The string that contains path to the resource.
bDIPath
[in, defaultvalue(0)] The optional flag, indicates should the input path be interpreted as device-independed.
pFSName
[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
[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.
ppRes
[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