NPN_GetValueForURL

« Gecko Plugin API Reference « Browser Side Plug-in API

Summary

Provides information to a plugin which is associated with a given URL, for example the cookies or preferred proxy.

Syntax

#include <npapi.h>

typedef enum {
  NPNURLVCookie = 501,
  NPNURLVProxy
} NPNURLVariable;

NPError NPN_GetValueForURL(NPP instance,
                           NPNURLVariable variable,
                           const char *url,
                           char **value,
                           uint32_t *len);

Parameters

This function has the following parameters:

instance: Pointer to the current plug-in instance.

variable: Selects the type of information to be retrieved (NPNURLVCookie or NPNURLVProxy)

url: The URL for which to fetch information.

value: Out parameter. The browser passes back the requested information. If the function succeeds, the result buffer will be allocated with NPN_MemAlloc; the plugin is responsible for freeing the buffer. Note: the value may have internal NULL bytes and may not be NULL-terminated.

When multiple cookies are returned for a given URL, the format of the return value is:
cookie1=value1;cookie2=value2;cookie3=value3

len: Out parameter. The length of the returned value buffer.

Returns

If successful, the function returns NPERR_NO_ERROR.
If unsuccessful, the function returns an error code. For possible values, see Error Codes.

Description

This entry point is designed to allow plugins which implement their own HTTP stacks to form requests to the web server in the same way the browser does.