IActiveScriptSite::GetItemInfoIActiveScriptSite::GetItemInfo

Permet au moteur de script obtenir des informations sur un élément ajouté avec le IActiveScript::AddNamedItem (méthode).Allows the scripting engine to obtain information about an item added with the IActiveScript::AddNamedItem method.

SyntaxeSyntax

HRESULT GetItemInfo(  
    LPCOLESTR pstrName,     // address of item name  
    DWORD dwReturnMask,     // bit mask for information retrieval  
    IUnknown **ppunkItem,   // address of pointer to item's IUnknown  
    ITypeInfo **ppTypeInfo  // address of pointer to item's ITypeInfo  
);  

ParamètresParameters

pstrName
[in] Le nom associé à l’élément, tel que spécifié dans le IActiveScript::AddNamedItem (méthode).[in] The name associated with the item, as specified in the IActiveScript::AddNamedItem method.

dwReturnMask
[in] Un masque de bits spécifiant les informations relatives à l’élément doivent être retournées.[in] A bit mask specifying what information about the item should be returned. Le moteur de script doit demander la quantité minimale d’informations possible, car certains des paramètres de retour (par exemple, ITypeInfo) peut prendre beaucoup de temps pour charger ou de générer.The scripting engine should request the minimum amount of information possible because some of the return parameters (for example, ITypeInfo) can take considerable time to load or generate. Peut être une combinaison des valeurs suivantes :Can be a combination of the following values:

ValueValue SignificationMeaning
SCRIPTINFO_IUNKNOWNSCRIPTINFO_IUNKNOWN Retourne le IUnknown interface pour cet élément.Returns the IUnknown interface for this item.
SCRIPTINFO_ITYPEINFOSCRIPTINFO_ITYPEINFO Retourne le ITypeInfo interface pour cet élément.Returns the ITypeInfo interface for this item.

ppunkItem
[out] Adresse d’une variable qui reçoit un pointeur vers le IUnknown interface associée à l’élément donné.[out] Address of a variable that receives a pointer to the IUnknown interface associated with the given item. Le moteur de script peut utiliser le IUnknown::QueryInterface méthode pour obtenir le IDispatch interface pour l’élément.The scripting engine can use the IUnknown::QueryInterface method to obtain the IDispatch interface for the item. Ce paramètre reçoit la valeur NULL si dwReturnMask n’inclut pas la valeur SCRIPTINFO_IUNKNOWN.This parameter receives NULL if dwReturnMask does not include the SCRIPTINFO_IUNKNOWN value. En outre, il reçoit NULL s’il n’existe aucun objet associé au nom de l’élément ; Ce mécanisme est utilisé pour créer une classe simple lorsque l’élément nommé a été ajouté avec l’indicateur SCRIPTITEM_CODEONLY défini dans le IActiveScript::AddNamedItem (méthode).Also, it receives NULL if there is no object associated with the item name; this mechanism is used to create a simple class when the named item was added with the SCRIPTITEM_CODEONLY flag set in the IActiveScript::AddNamedItem method.

ppTypeInfo
[out] Adresse d’une variable qui reçoit un pointeur vers le ITypeInfo interface associée à l’élément.[out] Address of a variable that receives a pointer to the ITypeInfo interface associated with the item. Ce paramètre reçoit la valeur NULL si dwReturnMask n’inclut pas la valeur SCRIPTINFO_ITYPEINFO, ou si les informations de type ne sont pas disponibles pour cet élément.This parameter receives NULL if dwReturnMask does not include the SCRIPTINFO_ITYPEINFO value, or if type information is not available for this item. Si les informations de type ne sont pas disponibles, l’objet ne peut pas extraire des événements, et liaison de nom doit être réalisée avec le IDispatch::GetIDsOfNames (méthode).If type information is not available, the object cannot source events, and name binding must be realized with the IDispatch::GetIDsOfNames method. Notez que le ITypeInfo interface récupéré décrit coclasse de l’élément (TKIND_COCLASS), car l’objet peut prendre en charge plusieurs interfaces et les interfaces d’événement.Note that the ITypeInfo interface retrieved describes the item's coclass (TKIND_COCLASS) because the object may support multiple interfaces and event interfaces. Si l’élément prend en charge la IProvideMultipleTypeInfo interface, le ITypeInfo interface récupéré est identique à l’index zéro ITypeInfo qui serait obtenue à l’aide de la IProvideMultipleTypeInfo::GetInfoOfIndex (méthode).If the item supports the IProvideMultipleTypeInfo interface, the ITypeInfo interface retrieved is the same as the index zero ITypeInfo that would be obtained using the IProvideMultipleTypeInfo::GetInfoOfIndex method.

Valeur de retourReturn Value

Retourne une des valeurs suivantes :Returns one of the following values:

Valeur de retourReturn Value SignificationMeaning
S_OK Opération réussie.Success.
E_INVALIDARG Un argument n’est pas valide.An argument was invalid.
E_POINTER Un pointeur non valide a été spécifié.An invalid pointer was specified.
TYPE_E_ELEMENTNOTFOUND Un élément portant le nom spécifié est introuvable.An item of the specified name was not found.

NotesRemarks

Cette méthode récupère uniquement les informations indiquées par le dwReturnMask paramètre ; cela améliore les performances.This method retrieves only the information indicated by the dwReturnMask parameter; this improves performance. Par exemple, si un ITypeInfo interface n’est pas nécessaire pour un élément, il est tout simplement pas spécifié dans dwReturnMask.For example, if an ITypeInfo interface is not needed for an item, it is simply not specified in dwReturnMask.

Voir aussiSee Also

IActiveScriptSiteIActiveScriptSite