SftPicture2 Documentation

Sft_InitPicture

Initialize a freshly allocated SFT_PICTURE so it represents an empty slot. Equivalent to memset(0).

C

void Sft_InitPicture(LPSFT_PICTURE lpPicture);

Parameters

lpPicture

Pointer to a SFT_PICTURE allocated by the application. Must not be NULL.

Comments

Call once on each application-allocated SFT_PICTURE before its first use. SFT_PICTURE fields embedded in per-product control structures are initialized by the host control automatically and do not need a separate Sft_InitPicture call.

After Sft_InitPicture, the structure has type = 0 (empty slot), default alignment values, and zero in every union member. Pass it to one of the Sft_SetPicture* setters to populate it with a picture.

Sft_InitPicture does not check for or release any resources that may have been stored in the structure - if the structure may currently hold a picture, use Sft_ClearPicture instead so the assertion in the FREE-flag check still fires.

See Also SftPicture2 | SFT_PICTURE | Sft_ClearPicture | Sft_InitText