WSGetLinksFromEnvironment （C 函数）

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

获取当前在 WSTP 环境 env 中打开的链接的列表，并将列表存储于 links 中，列表长度存储于 l 中.

更多信息

  • WSGetLinksFromEnvironment() 为存储必须调用 WSReleaseLinksFromEnvironment()才能释放的链接列表而分配内存. 若 WSGetLinksFromEnvironment() 返回错误，则不要调用有 links 内容的 WSReleaseLinksFromEnvironment().
  • 若 WSGetLinksFromEnvironment() 成功，则返回1；若失败，则返回0.
  • WSTP 的标头文件 wstp.h 已对 WSGetLinksFromEnvironment() 作出声明.

范例

基本范例  (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);
}