IVsPathVariableResolver.EncodePath(String, UInt32, String) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.8.0.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Encodes a file path by replacing the installation directory and the user application data directory with the strings %VS_INSTALL_DIRECTORY% and %USER_APPDATA% respectively.

public:
 int EncodePath(System::String ^ strPath, System::UInt32 dwFlags, [Runtime::InteropServices::Out] System::String ^ % pbstrEncodedPath);

int EncodePath(std::wstring const & strPath, unsigned int dwFlags, [Runtime::InteropServices::Out] std::wstring const & & pbstrEncodedPath);

public int EncodePath (string strPath, uint dwFlags, out string pbstrEncodedPath);

abstract member EncodePath : string * uint32 * string -> int

Public Function EncodePath (strPath As String, dwFlags As UInteger, ByRef pbstrEncodedPath As String) As Integer

Parameters

strPath: String

[in] String containing the path to encode.

dwFlags: UInt32

[in] Encoding option flag. A value from the __VSPROFILEPATHRESOLVERFLAGS enumeration.

pbstrEncodedPath: String

[out] A pointer to a string containing the encoded path.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell80.idl:

HRESULT IVsPathVariableResolver::EncodePath(  
   [in] LPCOLESTR strPath,   
   [in] VSPROFILEPATHRESOLVERFLAGS dwFlags,   
   [out] BSTR *pbstrEncodedPath  
);

Applies to