IAppxManifestApplication::GetStringValue method

Gets the value of a string element in the application metadata section of the manifest.

Syntax


HRESULT GetStringValue(
  [in]           LPCWSTR name,
  [out, retval]  LPWSTR *value
);

Parameters

name [in]

Type: LPCWSTR

The name of the string element to get from the application metadata. Valid values include:

"Description"

"DisplayName"

"EntryPoint"

"Executable"

"Id"

"Logo"

"SmallLogo"

"StartPage"

"Square150x150Logo" for Windows 8.1 and later

"Square30x30Logo" for Windows 8.1 and later

"BackgroundColor" for Windows 8.1 and later

"ForegroundText" for Windows 8.1 and later

"WideLogo" for Windows 8.1 and later

"Wide310x310Logo" for Windows 8.1 and later

"ShortName" for Windows 8.1 and later

"Square310x310Logo" for Windows 8.1 and later

"Square70x70Logo" for Windows 8.1 and later

"MinWidth" for Windows 8.1 and later

Refer to the schema to determine where these values are being read from.

value [out, retval]

Type: LPWSTR*

The value of the requested element.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

If the optional string value is not defined, this method returns E_INVALIDARG and value is NULL.

The caller must free the memory allocated for value using the CoTaskMemFree function.

Examples

For an example, see Quickstart: Read app package manifest info.

Requirements

Minimum supported client

Windows 8 [desktop apps only]

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

AppxPackaging.h

IDL

AppxPackaging.idl

IID

IID_IAppxManifestApplication is defined as 5da89bf4-3773-46be-b650-7e744863b7e8

See also

IAppxManifestApplication

 

 

Show:
© 2014 Microsoft