IAppxManifestDocument2.GetShareExtension Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Gets the Share extension.

public:
 bool GetShareExtension([Runtime::InteropServices::Out] System::String ^ % executable, [Runtime::InteropServices::Out] System::String ^ % entryPoint, [Runtime::InteropServices::Out] System::String ^ % runtimeType, [Runtime::InteropServices::Out] System::String ^ % startPage, [Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IAppxShareExtension ^ % shareExtensionData);

bool GetShareExtension([Runtime::InteropServices::Out] std::wstring const & & executable, [Runtime::InteropServices::Out] std::wstring const & & entryPoint, [Runtime::InteropServices::Out] std::wstring const & & runtimeType, [Runtime::InteropServices::Out] std::wstring const & & startPage, [Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IAppxShareExtension const & & shareExtensionData);

public bool GetShareExtension (out string executable, out string entryPoint, out string runtimeType, out string startPage, out Microsoft.VisualStudio.Shell.Interop.IAppxShareExtension shareExtensionData);

abstract member GetShareExtension : string * string * string * string * IAppxShareExtension -> bool

Public Function GetShareExtension (ByRef executable As String, ByRef entryPoint As String, ByRef runtimeType As String, ByRef startPage As String, ByRef shareExtensionData As IAppxShareExtension) As Boolean

Parameters

executable

String

[out] The executable field of the App manifest.

entryPoint

String

[out] The entryPoint field of the app manifest.

runtimeType

String

[out] ] The runtimeType field of the app manifest.

startPage

String

[out] The startPage field of the app manifest.

shareExtensionData

IAppxShareExtension

[out] An IAppxShareExtension object that allows mutation of the manifest's File Open Picker extension.

Returns

Boolean

true if there is a Share extension associated with the manifest.

Implements

GetShareExtension(String, String, String, String, IAppxShareExtension)

Remarks

Because at most one Share extension is allowed per manifest, there is no ambiguity as to which data is returned by this method.

This method returns an IAppxShareExtension object that allows mutation of the manifest's Share extension. This Share extension data object goes stale whenever there is no Share extension associated with the manifest. So, when this method is called, the resulting shareExtensionData is useful only if the value returned by this method is true. If RemoveShareExtension is called, shareExtensionData becomes stale, and must be replenished with another call to this method.