AfScriptLstGet: Unterschied zwischen den Versionen

Aus ArcFlow Wiki
Zur Navigation springen Zur Suche springen
K Stand 4.1.09
K Stand 4.1.16 Ausführbar ArcFlow.NEXT und Beispiel hinzugefügt
 
(3 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt)
Zeile 8: Zeile 8:
     <td class="title">&nbsp;AfScriptLstGet(handle1) : int</td>
     <td class="title">&nbsp;AfScriptLstGet(handle1) : int</td>
     <td class="platforms">
     <td class="platforms">
[[file:DE_SymbolAPI.gif|alt=Ausführbar von der API|link=Befehle der Schnittstellen]][[file:DE_SymbolNoDLL.gif|alt=Nicht ausführbar von der Programmierschnittstelle (DLL)|link=Befehle der Schnittstellen]][[file:DE_SymbolNoARC.gif|alt=Nicht ausführbar mit der Application Remote Control|link=Befehle der Schnittstellen]][[file:DE_SymbolScriptAPI.gif|alt=Ausführbar von der Script-API|link=Befehle der Schnittstellen]]
[[file:DE_SymbolAPI.gif|alt=Ausführbar von der API|link=Befehle der Schnittstellen|Ausführbar von der API]][[file:DE_SymbolNoDLL.gif|alt=Nicht ausführbar von der Programmierschnittstelle (DLL)|link=Befehle der Schnittstellen|Nicht ausführbar von der Programmierschnittstelle (DLL)]][[file:DE_SymbolNoARC.gif|alt=Nicht ausführbar mit der Application Remote Control|link=Befehle der Schnittstellen|Nicht ausführbar mit der Application Remote Control]][[file:DE_SymbolNoScriptAPI.gif|alt=Nicht ausführbar von der ScriptAPI|link=Befehle der Schnittstellen|Nicht ausführbar von der ScriptAPI]][[file:SymbolNext.gif|alt=Ausführbar von ArcFlow.NEXT|link=Befehle der Schnittstellen|Ausführbar von ArcFlow.NEXT]]
     </td>
     </td>
   </tr>
   </tr>
Zeile 65: Zeile 65:
   </tr>
   </tr>
</table>
</table>
== Beispiele ==
<tabber>
|-|ScriptAPI=
<pre class=source>
tCteList # AfCteOpen(_CteList);
tResult # AfScriptLstGet(tCteList);
for tCteItem # tCteList->CteRead(_CteFirst);
loop tCteItem # tCteList->CteRead(_CteNext, tCteItem);
while (sAFHdlExists(tCteItem))
{
  tScriptName # tCteItem->spName; // AfArcSearchToAbm
  tUser # AfStrGet(tCteItem->spCustom,'#$#',1); // admin out of admin#$#28.06.2024#$#15:09#$#Add-on - Kontextmenü: AfArcSearchToAbm
  ...
}
tCteList->AfCteCloseAll();
</pre>
|-|ArcFlowAPI=
<pre class=source>
tCteList # CteOpen(_CteList);
tResult # AF.API:AfScriptLstGet(tCteList);
for tCteItem # tCteList->CteRead(_CteFirst);
loop tCteItem # tCteList->CteRead(_CteNext, tCteItem);
while (tCteItem > 0)
{
  tScriptName # tCteItem->spName; // AfArcSearchToAbm
  tUser # AF.API:AfStrGet(tCteItem->spCustom,'#$#',1); // admin out of admin#$#28.06.2024#$#15:09#$#Add-on - Kontextmenü: AfArcSearchToAbm
  ...
}
tCteList->CteClear(true);
tCteList->CteClose();
</pre>
|-|ArcFlow.NEXT=
<pre class=source>
af.next.AfScriptLstGet().then( result => {
  result.returnValues.scriptList.forEach(script => {
      console.log(script.afScriptName+'/'+script.afInformations);
  });
});
</pre>
Es werden keine Skripte von ArcFlow.NEXT zurückgegeben. Das Resultat nach erfolgreicher Ausführung der Anweisung befindet sich in folgenden Variablen:
{| class="wikitable" style="margin-left: 0px; margin-right: auto; text-align: left;"
! Variable !! Bedeutung
|-
| ...returnValues.afScriptList || Array mit Skriptinformationen
|-
| ...returnValues.afScriptList[0].afScriptName || Name desSkripts
|-
| ...returnValues.afScriptList[0].afInformations || Informationen zum Skript mit "#$#" getrennt
|-
| ...returnValues.afScriptList.length || Anzahl der Skripte
|}
</tabber>


<p>Es werden nur die [[Allgemeine Fehlercodes#|allgemeinen Fehlerwerte]] zurückgegeben.</p></p>
<p>Es werden nur die [[Allgemeine Fehlercodes#|allgemeinen Fehlerwerte]] zurückgegeben.</p></p>

Aktuelle Version vom 20. Februar 2026, 08:16 Uhr

 AfScriptLstGet(handle1) : int

Ausführbar von der APINicht ausführbar von der Programmierschnittstelle (DLL)Nicht ausführbar mit der Application Remote ControlNicht ausführbar von der ScriptAPIAusführbar von ArcFlow.NEXT

Informationen zu einem Skript ermitteln
handle1 Deskriptor einer leeren CTE-Liste
Resultat int Fehlerwert
Siehe

Verwandte Befehle

Mit dieser Funktion können Informationen über die in ArcFlow vorhandenen Skripte ermittelt werden. Im Parameter (handle1) muss der Deskriptor einer leeren Cte-Liste übergeben werden, die vor dem Aufruf der Funktion über den Befehl AfCteOpen() angelegt wurde.

Nach dem Aufruf der Funktion ist pro Skript ein Objekt in der Cte-Liste vorhanden. Die Objekte können geladen und über die Eigenschaft "Name" der Name des Skripts ermittelt werden. In der Eigenschaft "Custom" stehen weitere Informationen mit #$# getrennt zur Verfügung. Die Informationen können zum Beispiel mit der Anweisung AfStrGet() ermittelt werden:

AfStrGet(tCteItem->spCustom,'#$#',1) Benutzerkürzel, der zuletzt das Skript geändert hat.
AfStrGet(tCteItem->spCustom,'#$#',2) Datum der letzten Änderung.
AfStrGet(tCteItem->spCustom,'#$#',3) Uhrzeit der letzten Änderung.
AfStrGet(tCteItem->spCustom,'#$#',4) Information, wo das Skript aufgerufen wird.

Beispiele

tCteList # AfCteOpen(_CteList);
tResult # AfScriptLstGet(tCteList);
for tCteItem # tCteList->CteRead(_CteFirst);
loop tCteItem # tCteList->CteRead(_CteNext, tCteItem);
while (sAFHdlExists(tCteItem))
{
  tScriptName # tCteItem->spName; // AfArcSearchToAbm
  tUser # AfStrGet(tCteItem->spCustom,'#$#',1); // admin out of admin#$#28.06.2024#$#15:09#$#Add-on - Kontextmenü: AfArcSearchToAbm
  ...
}
tCteList->AfCteCloseAll();

tCteList # CteOpen(_CteList);
tResult # AF.API:AfScriptLstGet(tCteList);
for tCteItem # tCteList->CteRead(_CteFirst);
loop tCteItem # tCteList->CteRead(_CteNext, tCteItem);
while (tCteItem > 0)
{
  tScriptName # tCteItem->spName; // AfArcSearchToAbm
  tUser # AF.API:AfStrGet(tCteItem->spCustom,'#$#',1); // admin out of admin#$#28.06.2024#$#15:09#$#Add-on - Kontextmenü: AfArcSearchToAbm
  ...
}
tCteList->CteClear(true);
tCteList->CteClose();

af.next.AfScriptLstGet().then( result => {
  result.returnValues.scriptList.forEach(script => {
      console.log(script.afScriptName+'/'+script.afInformations);
  });
});

Es werden keine Skripte von ArcFlow.NEXT zurückgegeben. Das Resultat nach erfolgreicher Ausführung der Anweisung befindet sich in folgenden Variablen:

Variable Bedeutung
...returnValues.afScriptList Array mit Skriptinformationen
...returnValues.afScriptList[0].afScriptName Name desSkripts
...returnValues.afScriptList[0].afInformations Informationen zum Skript mit "#$#" getrennt
...returnValues.afScriptList.length Anzahl der Skripte

Es werden nur die allgemeinen Fehlerwerte zurückgegeben.