Structure PROPPAGEINFO (ocidl.h)

Contient les paramètres utilisés pour décrire une page de propriétés dans un cadre de propriété. Une page de propriétés remplit une structure fournie par l’appelant dans la méthode IPropertyPage ::GetPageInfo .

Syntaxe

typedef struct tagPROPPAGEINFO {
  ULONG    cb;
  LPOLESTR pszTitle;
  SIZE     size;
  LPOLESTR pszDocString;
  LPOLESTR pszHelpFile;
  DWORD    dwHelpContext;
} PROPPAGEINFO, *LPPROPPAGEINFO;

Membres

cb

Taille de la structure, en octets.

pszTitle

Pointeur vers un OLESTR qui contient la chaîne qui apparaît dans l’onglet de cette page. La chaîne doit être allouée avec CoTaskMemAlloc. L’appelant de IPropertyPage ::GetPageInfo est chargé de libérer la mémoire avec CoTaskMemFree.

size

Dimensions requises de la boîte de dialogue de la page, en pixels.

pszDocString

Pointeur vers une chaîne de texte décrivant la page, qui peut être affichée dans la boîte de dialogue feuille de propriétés (l’implémentation du cadre actuel n’utilise pas ce champ). Le texte doit être alloué avec CoTaskMemAlloc. L’appelant de IPropertyPage ::GetPageInfo est chargé de libérer la mémoire avec CoTaskMemFree.

pszHelpFile

Pointeur vers un OLESTR qui contient le nom simple du fichier d’aide qui décrit cette page de propriétés utilisée au lieu d’implémenter IPropertyPage ::Help. Lorsque l’utilisateur appuie sur Aide, la méthode Help est normalement appelée. Si cette méthode échoue, le cadre ouvre le système d’aide avec ce fichier d’aide (précédé de la valeur de la clé HelpDir dans les entrées de Registre de la page de propriétés sous son CLSID) et indique au système d’aide d’afficher le contexte décrit par le champ dwHelpContext . Le chemin d’accès doit être alloué avec CoTaskMemAlloc. L’appelant de IPropertyPage ::GetPageInfo est chargé de libérer la mémoire avec CoTaskMemFree.

dwHelpContext

Identificateur de contexte pour la rubrique d’aide dans pszHelpFile qui décrit cette page.

Remarques

Les membres pszTitle, pszDocString et pszHelpFile spécifiés dans cette structure doivent contenir du texte sensible aux paramètres régionaux obtenus via IPropertyPageSite ::GetLocaleID.

Configuration requise

Voir aussi

IPropertyPage ::GetPageInfo

IPropertyPageSite ::GetLocaleID

OLESTR