Retrieves a preview image for a Favorite.

    GSErrCode  ACAPI_Favorite_GetPreviewImage (
        const GS::UniString&        name,
        API_ImageViewID             viewType,
        NewDisplay::NativeImage     *nativeImagePtr;
    );

 

Parameters

name

[in] The name of the existing Favorite entry.

viewType

[in] The view type identifier.

nativeImagePtr

[out] Pointer to the output native image.

 

Return Values

NoError

The function has completed with success.

APIERR_BADNAME

Invalid name given (there is no Favorite with the given name).

APIERR_GENERAL

The preview image cannot be generated.

APIERR_BADPARS

nativeImagePtr parameter is nullptr.

For other common API errors see the API Errors document.

 

Example

// -----------------------------------------------------------------------------
// Get preview images for Favorite named "Favorite_Test"
//  - draw them into useritems on a new modal dialog
// -----------------------------------------------------------------------------

static void     Do_GetPreviewImagesOfFavorite (void)
{
    GSErrCode           err;
    const GS::UniString favoriteName = "Favorite_Test";

    ACAPI_WriteReport ("### Favorite_Test Do_GetPreviewImagesOfFavorite ###", false);

    NewDisplay::NativeImage     sectionNativeImage (250, 250, 32, nullptr);
    NewDisplay::NativeImage     model2DNativeImage (250, 250, 32, nullptr);
    NewDisplay::NativeImage     model3DNativeImage (250, 250, 32, nullptr);

    err = ACAPI_Favorite_GetPreviewImage (favoriteName, APIImage_Section, &sectionNativeImage);
    err = ACAPI_Favorite_GetPreviewImage (favoriteName, APIImage_Model2D, &model2DNativeImage);
    err = ACAPI_Favorite_GetPreviewImage (favoriteName, APIImage_Model3D, &model3DNativeImage);
    if (err != NoError) {
        if (err == APIERR_BADNAME)
            ACAPI_WriteReport ("ACAPI_Favorite_GetPreviewImage failed because bad name was given", false);
        else
            ACAPI_WriteReport ("ACAPI_Favorite_GetPreviewImage failed", false);
    } else {
        UserItemDialog dialog (sectionNativeImage, model2DNativeImage, model3DNativeImage);
        dialog.Invoke ();
    }

    return;
}       /* Do_GetPreviewImagesOfFavorite */

For more detailed examples, please see the Favorite_Test example Add-On.

 

Requirements

Version: API 23 or later

Header: ACAPinc.h

 

See Also

ACAPI_Favorite_Change,
ACAPI_Favorite_Create,
ACAPI_Favorite_Delete,
ACAPI_Favorite_Export,
ACAPI_Favorite_Get,
ACAPI_Favorite_GetNum,
ACAPI_Favorite_Import,
ACAPI_Favorite_Read,

API Functions