IAppxManifestDocument.GetFileOpenPickerExtension Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Gets the File Open Picker extension.

public:
 bool GetFileOpenPickerExtension([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::IAppxFileOpenPickerExtension ^ % fileOpenPickerExtensionData);

bool GetFileOpenPickerExtension([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::IAppxFileOpenPickerExtension const & & fileOpenPickerExtensionData);

public bool GetFileOpenPickerExtension (out string executable, out string entryPoint, out string runtimeType, out string startPage, out Microsoft.VisualStudio.Shell.Interop.IAppxFileOpenPickerExtension fileOpenPickerExtensionData);

abstract member GetFileOpenPickerExtension : string * string * string * string * IAppxFileOpenPickerExtension -> bool

Public Function GetFileOpenPickerExtension (ByRef executable As String, ByRef entryPoint As String, ByRef runtimeType As String, ByRef startPage As String, ByRef fileOpenPickerExtensionData As IAppxFileOpenPickerExtension) 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.

fileOpenPickerExtensionData

IAppxFileOpenPickerExtension

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

Returns

Boolean

true if there is a File Open Picker extension associated with the manifest.

Remarks

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

File Open Picker extensions do not have DataFormat elements.

The File Open Picker extension data object (returned in fileOpenPickerExtensionData) goes stale whenever there is no File Open Picker extension associated with the manifest. So, when this method is called, the resulting fileOpenPickerExtensionData is useful only if the value returned by this method is true. If RemoveShareExtension is called, fileOpenPickerExtensionData becomes stale, and must be replenished with another call to this method.