IPXV_Inst::PathToName Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXV_Inst::PathToName Method}} | {{#customTitle:IPXV_Inst::PathToName Method}} | ||
| − | {{#parentPage:PXV:IPXV_Inst#Methods|PathToName | + | {{#parentPage:PXV:IPXV_Inst#Methods|PathToName|method}} |
| − | + | ||
{{ToReview}} | {{ToReview}} | ||
| − | The | + | 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 == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT PathToName([in] LPWSTR | + | <pre class="brush:cpp;gutter:false">HRESULT PathToName([in] LPWSTR sPath, |
[in, defaultvalue(0)] VARIANT_BOOL bDIPath, | [in, defaultvalue(0)] VARIANT_BOOL bDIPath, | ||
| − | [in, defaultvalue("")] BSTR | + | [in, defaultvalue("")] BSTR sFSName, |
[in, defaultvalue(-1)] VARIANT_BOOL bAllowAuth, | [in, defaultvalue(-1)] VARIANT_BOOL bAllowAuth, | ||
[in, defaultvalue(0)] HANDLE_T hWndParent, | [in, defaultvalue(0)] HANDLE_T hWndParent, | ||
| − | [out, retval] IAFS_Name** | + | [out, retval] IAFS_Name** pRes);</pre> |
== Parameters == | == Parameters == | ||
| − | ; | + | ;sPath |
| − | :[in] | + | :[in] The string that contains path to the resource. |
;bDIPath | ;bDIPath | ||
| − | :[in, defaultvalue(0)] | + | :[in, defaultvalue(0)] The optional flag, indicates should the input path be interpreted as device-independed. |
| − | ; | + | ;sFSName |
| − | :[in, defaultvalue("")] | + | :[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)] | + | :[in, defaultvalue(-1)] The optional flag to allow/prevent the interactive authentication. |
;hWndParent | ;hWndParent | ||
| − | :[in, defaultvalue(0)] | + | :[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 |
| − | :[out, retval] | + | :[out, retval] Returns pointer to [[PXV:IAFS_Name|IAFS_Name]] object. |
== Return Value == | == Return Value == | ||
| Line 34: | Line 33: | ||
== See Also == | == See Also == | ||
| − | [[PXV:IPXV_Inst|IPXV_Inst]] | + | [[PXV:IPXV_Inst|IPXV_Inst]] |
Latest revision as of 03:57, 15 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 sPath,
[in, defaultvalue(0)] VARIANT_BOOL bDIPath,
[in, defaultvalue("")] BSTR sFSName,
[in, defaultvalue(-1)] VARIANT_BOOL bAllowAuth,
[in, defaultvalue(0)] HANDLE_T hWndParent,
[out, retval] IAFS_Name** pRes);
Parameters
- sPath
- [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.
- sFSName
- [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.
- pRes
- [out, retval] Returns pointer to IAFS_Name object.
Return Value
Returns S_OK if operation was successful or error code in other cases.
