IPXV_Inst::PathToName Method

PDF Editor Layer > Interfaces > IPXV_Inst > IPXV_Inst::PathToName Method

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.

See Also

IPXV_Inst