Aide:DllStructGetData.txt

Document original V3.3.6.1 :

###Function###
DllStructGetData

###Description###
Returns the data of an element of the struct.

###Syntax###
DllStructGetData ( Struct, Element [, index ] )


###Parameters###
@@ParamTable@@
Struct
	The struct returned by DllStructCreate.
Element
	Which element of the struct you want to access, starting at 1 or the elementname as defined in DllStructCreate.
index
	[optional] For elements that are an array this specifies the 1-based index to retrieve.  if omitted or the Default keyword then the entire array is retrieved (Useful for quickly retrieving strings).  <b>Not used for non-array elements.</b>
@@End@@
*char[n], byte[n] and ubyte[n] return all element data when index is omitted.

###ReturnValue###
@@ReturnTable@@
Success:	Data in the element of the struct.
Failure:	0.
@Error:	0 = No Error.
	1 = Struct not a correct struct returned by DllStructCreate.
	2 = Element value out of range.
	3 = index would be outside of the struct.
	4 = Element data type is unknown
	5 = index &lt;= 0.
@@End@@


###Remarks###
When the element is char[n] and index is omitted the data returned is a String,
when the element is byte[n] or ubyte[n] and index is omitted the data returned is a binary type,
otherwise it always returns a number.

###Related###
DllStructCreate, DllStructSetData


###Example###
@@IncludeExample@@

Document traduit V3.3.6.1 :

###Function###
DllStructGetData

###Description###
Retourne les données d'un élément de la structure.

###Syntax###
DllStructGetData ( Struct, Element [, index ] )


###Parameters###
@@ParamTable@@
Struct
	La structure renvoyée par DllStructCreate.
Element
	L'élément de la structure auquel vous souhaitez accéder, à partir de 1 ou du nom de l'élément tel que défini dans DllStructCreate.
index
	[optionnel] Pour les éléments qui sont dans un tableau spécifie par l'index de base 1 à récupérer. s'il est omis ou si le mot-clé par défaut est omis, l'ensemble du tableau est récupéré (utile pour récupérer rapidement les chaînes).  <b>Non utilisé pour les éléments non-array.</b>
@@End@@
*char[n], byte[n] et ubyte[n] retourne toutes les données de l'élément lorsque l'indice est omis.

###ReturnValue###
@@ReturnTable@@
Succès:	Les données dans l'élément de la structure.
Échec:	0.
@Error:	0 = Pas d'erreur.
	1 = La structure n'est pas une structure correcte retourné par DllStructCreate.
	2 = Valeur de l'élément hors de portée.
	3 = L'index serait en dehors de la structure.
	4 = Élément de données type est inconnu
	5 = index &lt;= 0.
@@End@@


###Remarks###
Lorsque l'élément char[n] et l'index sont omis les données renvoyé sont une chaîne,
lorsque l'élément byte[n] ou ubyte[n] et l'index sont omis les données renvoyées sont de type binaire,
sinon, elle retourne toujours un nombre.

###Related###
DllStructCreate, DllStructSetData


###Example###
@@IncludeExample@@

Traducteur : TT22

Contributeurs (pour les modifications avant le Wiki) :