IVsPathVariableResolver::EncodePath Method (String^, UInt32, String^)

Visual Studio 2015

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.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop.8.0 (in Microsoft.VisualStudio.Shell.Interop.8.0.dll)

Syntax

C++

int EncodePath(
	String^ strPath,
	unsigned int dwFlags,
	[OutAttribute] String^% pbstrEncodedPath
)

Parameters

strPath: Type: System::String^
[in] String containing the path to encode.

dwFlags: Type: System::UInt32
[in] Encoding option flag. A value from the __VSPROFILEPATHRESOLVERFLAGS enumeration.

pbstrEncodedPath: Type: System::String^
[out] A pointer to a string containing the encoded path.

Return Value

Type: System::Int32

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

Remarks

COM Signature

From vsshell80.idl:

C++

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