tag_afs_msg_announce_v1 Struct Reference

Parameter structure for announcing an extension plugin. More...

#include <afspext.h>

Data Fields
khm_size	cbsize
	Size of the strucutre.
khm_ui_4	version
	Version of the AFS plugin that the extension is compiled for.
const wchar_t *	name
	Name of the extension.
khm_handle	sub
	A valid subscription for unicast messages.
khm_boolean	provide_token_acq
	non-zero if the extension provides a token acquisition method.
struct {
const wchar_t *   short_desc
	Short description of token acquisition method.
const wchar_t *   long_desc
	Long description.
afs_tk_method   method_id
	Once the message is processed, this will receive a new method identifier.
}	token_acq
	Registration information for token acquisition method.

---

Detailed Description

Parameter structure for announcing an extension plugin.

See also:

AFS_MSG_ANNOUNCE

---

Field Documentation

khm_size cbsize

Size of the strucutre.

Set to sizeof(::afs_msg_announce). If there is a version skew between the AFS plugin and the extension, then this parameter will ensure that the AFS plugin understands the correct version of the structure.

const wchar_t* long_desc

Long description.

(localized, optional). Size is constrained by ::KHUI_MAXCCH_LONG_DESC

afs_tk_method method_id

Once the message is processed, this will receive a new method identifier.

The value of this field on entry is ignored.

const wchar_t* name

Name of the extension.

Should be unique among all AFS extension plugins. Size constrained by ::KHUI_MAXCCH_NAME

khm_boolean provide_token_acq

non-zero if the extension provides a token acquisition method.

The token_acq substructure should be filled if this member is set to non-zero.

const wchar_t* short_desc

Short description of token acquisition method.

(localized, required). Size is constrained by ::KHUI_MAXCCH_SHORT_DESC

khm_handle sub

A valid subscription for unicast messages.

This must have been created through kmq_create_subscription(). The supplied handle will be automatically released when the plugin exits. However, if the announcement message fails, then the extension has to release the handle itself.

struct { ... } token_acq

Registration information for token acquisition method.

Only assumed to be valid if provide_token_acq is TRUE.

khm_ui_4 version

Version of the AFS plugin that the extension is compiled for.

Set this to AFS_PLUGIN_VERSION. Depending on this value, the AFS plugin will either reject the extension or determine which set of messages and structures should be used to communicate with the extension.

---

The documentation for this struct was generated from the following file:

• /cygdrive/c/src/openafs/openafs.git/repo/src/WINNT/netidmgr_plugin/afspext.h