WSGetLinksFromEnvironment （C 関数）

int WSGetLinksFromEnvironment( WSENV env , WSLINK ** links , int * l )

WSTP環境 env で現在開いているリンクのリストを得て，そのリストを links に，リストの長さを l に保存する．

詳細

  • WSGetLinksFromEnvironment()はメモリを割り当てて，WSReleaseLinksFromEnvironment()を呼び出すことによって解放しなくてはならないリンクのリストを保存する．WSGetLinksFromEnvironment()がエラーを返す場合には，links の内容に対してWSReleaseLinksFromEnvironment()を呼び出してはならない．
  • WSGetLinksFromEnvironment()は，成功した場合には1を，失敗した場合には0を返す．
  • WSGetLinksFromEnvironment()は，WSTPヘッダファイルwstp.hの中で宣言される．

例題

例  (1)

#include "wstp.h"

void examineTheLinks(WSENV env)
{
    WSLINK *theLinks;
    int length;
    int apiResult;

    apiResult = WSGetLinksFromEnvironment(env, &theLinks, &length);
    if(! apiResult)
    { /* Unable to retrieve the list of open links */ }

    /* ... */

    WSReleaseLinksFromEnvironment(env, theLinks, length);
}