Share via


IAppxManifestDocument2.GetShareExtension Method

Gets the Share extension.

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

Syntax

'Declaration
Function GetShareExtension ( _
    <OutAttribute> ByRef executable As String, _
    <OutAttribute> ByRef entryPoint As String, _
    <OutAttribute> ByRef runtimeType As String, _
    <OutAttribute> ByRef startPage As String, _
    <OutAttribute> ByRef shareExtensionData As IAppxShareExtension _
) As Boolean
bool GetShareExtension(
    out string executable,
    out string entryPoint,
    out string runtimeType,
    out string startPage,
    out IAppxShareExtension shareExtensionData
)
bool GetShareExtension(
    [OutAttribute] String^% executable, 
    [OutAttribute] String^% entryPoint, 
    [OutAttribute] String^% runtimeType, 
    [OutAttribute] String^% startPage, 
    [OutAttribute] IAppxShareExtension^% shareExtensionData
)
abstract GetShareExtension : 
        executable:string byref * 
        entryPoint:string byref * 
        runtimeType:string byref * 
        startPage:string byref * 
        shareExtensionData:IAppxShareExtension byref -> bool
function GetShareExtension(
    executable : String, 
    entryPoint : String, 
    runtimeType : String, 
    startPage : String, 
    shareExtensionData : IAppxShareExtension
) : boolean

Parameters

  • executable
    Type: String%

    [out] The executable field of the App manifest.

  • entryPoint
    Type: String%

    [out] The entryPoint field of the app manifest.

  • runtimeType
    Type: String%

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

  • startPage
    Type: String%

    [out] The startPage field of the app manifest.

Return Value

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

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.

.NET Framework Security

See Also

Reference

IAppxManifestDocument2 Interface

Microsoft.VisualStudio.Shell.Interop Namespace