Méthode IOleUIObjInfoW ::GetObjectInfo (oledlg.h)

Article
03/01/2024

Obtient les informations de taille, de type, de nom et d’emplacement d’un objet.

Syntaxe

HRESULT GetObjectInfo(
  [in]            DWORD  dwObject,
  [out]           DWORD  *lpdwObjSize,
  [out, optional] LPWSTR *lplpszLabel,
  [out, optional] LPWSTR *lplpszType,
  [out, optional] LPWSTR *lplpszShortType,
  [out, optional] LPWSTR *lplpszLocation
);

Paramètres

[in] dwObject

Identificateur unique pour l’objet .

[out] lpdwObjSize

Pointeur vers la taille de l’objet, en octets, sur le disque. Il peut s’agir d’une valeur approximative.

[out, optional] lplpszLabel

Adresse d’une variable pointeur qui reçoit un pointeur vers la chaîne d’étiquette de l’objet. Ce paramètre peut avoir la valeur NULL pour indiquer que l’implémentation ne doit pas retourner la chaîne d’étiquette.

[out, optional] lplpszType

Adresse d’une variable pointeur qui reçoit un pointeur vers la chaîne de type long de l’objet. Ce paramètre peut avoir la valeur NULL pour indiquer que l’implémentation ne doit pas retourner la chaîne de type long.

[out, optional] lplpszShortType

Adresse d’une variable pointeur qui reçoit un pointeur vers la chaîne de type court de l’objet. Ce paramètre peut avoir la valeur NULL pour indiquer que l’implémentation ne doit pas retourner la chaîne de type court.

[out, optional] lplpszLocation

Adresse d’une variable pointeur qui reçoit un pointeur vers la chaîne d’emplacement source de l’objet. Ce paramètre peut avoir la valeur NULL pour indiquer que l’implémentation ne doit pas retourner la chaîne d’emplacement.

Valeur retournée

Cette méthode retourne S_OK en cas de réussite. Les autres valeurs de retour possibles sont les suivantes.

Code de retour	Description
E_FAIL	L'opération a échoué.
E_INVALIDARG	L’identificateur spécifié n’est pas valide.
E_OUTOFMEMORY	La mémoire disponible pour cette opération est insuffisante.

Remarques

Les chaînes et la taille de l’objet sont affichées dans la page Général des propriétés de l’objet.

Notes aux implémenteurs

Votre implémentation de GetObjectInfo doit placer chacun des attributs de l’objet dans les paramètres de sortie fournis. Définissez lpdwObjSize sur (DWORD)-1 lorsque la taille de l’objet est inconnue. Allouez toutes les chaînes (le reste des paramètres) avec l’allocateur de tâches OLE obtenu via CoGetMalloc, comme c’est standard pour toutes les interfaces OLE avec des paramètres de chaîne [out], ou vous pouvez simplement utiliser CoTaskMemAlloc.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	oledlg.h

Voir aussi

CoGetMalloc

CoTaskMemAlloc

IOleUIObjInfo

Partager via