XtfGetAumid
Gets the Application User Model ID (AUMID) at the specified index from a package information object.Syntax
Parameters
packageInfoType: XtfPackageInfo [in] The pointer to the information object for a package. aumidIndex
Type: UINT32 [in] Index of the AUMID in the package. aumid
Type: PWSTR [out, optional] The AUMID at the index specified in
aumidIndex for the package.
aumidBufferLengthType: UINT32 * [in, out] The length, in WCHAR, allocated for
aumid.
Return value
Type: HRESULT ReturnsS_OK if successful. If aumid is not large enough, this function returns HRESULT_FROM_WIN32(ERROR_MORE_DATA) and the required buffer length is returned in aumidBufferLength.
Remarks
Use this function to get the AUMID at the index specified inaumidIndex from the information object for a registered package. A pointer to a package information object is returned by calling either the XtfRegisterPackage or XtfRegisterNetworkSharePackage function to register a package.
Before calling this function, use the XtfGetcountofAppUserModelIds function to get the count of AUMIDs for the package. If you specify a value in aumidIndex that’s equal to or greater than the value returned by XtfGetcountofAppUserModelIds, an error occurs. Similarly, an error occurs if there’s no data to retrieve at the index specified in aumidIndex.
You can also use the XtfGetPackageFullName function to retrieve the full name of a registered package. For more information about packages, see Packaging.
Requirements
Header: xtfapi.h Library: XtfApi.lib Supported platforms: Windows (for XBOX console tools)See also
XTF Transport Errors (NDA topic)XtfRegisterPackage
XtfRegisterNetworkSharePackage
Additional Xtf APIs