Functions
Icon and IconFrame

Functions

StatusInt mdlDialog_iconCmdGetInfo (RawItemHdr *iconCmdP, RscId *iconCmdIdP, WChar const **ownerTaskIdPP, IconRsc **iconRscPP, CommandNumber *commandNumberP, WChar const **commandTaskIdPP, UInt32 *attributesP, int *iconWidthP, int *iconHeightP, IconCmdSelectType *selectTypeP)
 Gets specific information about the specified icon command. More...
 
StatusInt mdlDialog_iconCmdSetInfo (RawItemHdr *iconCmdP, int *iconCmdIdP, MdlDesc **iconOwnerMDP, CommandNumber *commandNumberP, WChar const **commandTaskIdPP, UInt32 *attributesP)
 Sets specific information about the specified icon command. More...
 
StatusInt mdlDialog_iconCmdSetNamedIcon (RawItemHdr *iconCmdP, WCharCP iconName)
 Sets the named icon for the specified icon command. More...
 

Detailed Description

Function Documentation

StatusInt mdlDialog_iconCmdGetInfo ( RawItemHdr iconCmdP,
RscId iconCmdIdP,
WChar const **  ownerTaskIdPP,
IconRsc **  iconRscPP,
CommandNumber *  commandNumberP,
WChar const **  commandTaskIdPP,
UInt32 attributesP,
int *  iconWidthP,
int *  iconHeightP,
IconCmdSelectType selectTypeP 
)

Gets specific information about the specified icon command.

Any of the arguments receiving information back from this function may be set to NULL if that information is not needed.

Parameters
[in]iconCmdPspecifies the icon command to get information about.
[out]iconCmdIdPreceives the icon command Id.
[out]ownerTaskIdPPreceives a pointer to the icon command owner task Id.
[out]iconRscPPreceives a pointer to the icon resource.
[out]commandNumberPreceives the command number of the icon command.
[out]commandTaskIdPPreceives a pointer to the command task Id.
[out]attributesPreceives the attributes set on the specified icon command.
[out]iconWidthPreceives the icon width of the specified icon command (including the bevel).
[out]iconHeightPreceives the icon height of the specified icon command (including the bevel).
[out]selectTypePreceives the selectType of the specified icon command.
Returns
SUCCESS on success or non-zero value if an error occurs.
See also
mdlDialog_iconCmdSetInfo
StatusInt mdlDialog_iconCmdSetInfo ( RawItemHdr iconCmdP,
int *  iconCmdIdP,
MdlDesc **  iconOwnerMDP,
CommandNumber *  commandNumberP,
WChar const **  commandTaskIdPP,
UInt32 attributesP 
)

Sets specific information about the specified icon command.

Parameters
[in]iconCmdPspecifies the icon command to get information about.
[in]iconCmdIdPspecifies the icon command Id.
[in]iconOwnerMDPspecifies the icon command owner task Id.
[in]commandNumberPspecifies the command number of the icon command.
[in]commandTaskIdPPspecifies the command task Id.
[in]attributesPspecifies the attributes set on the specified icon command.
Returns
SUCCESS on success or non-zero value if an error occurs.
See also
mdlDialog_iconCmdGetInfo
StatusInt mdlDialog_iconCmdSetNamedIcon ( RawItemHdr iconCmdP,
WCharCP  iconName 
)

Sets the named icon for the specified icon command.

Parameters
[in]iconCmdPspecifies the icon command to set the name for.
[in]iconNamename of the icon

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.