illumos: manual page: vnd_prop

VND_PROP_WRITEABLE(3VND) VND_PROP_WRITEABLE(3VND)

NAME

vnd_prop_writeable - determine if a vnd property can be updated

SYNOPSIS

cc [ flag... ] file... -lvnd [ library... ]
#include <libvnd.h>

int vnd_prop_writeable(vnd_prop_t prop, boolean_t *wp);

DESCRIPTION

The vnd_prop_writeable function is used as a programmatic means to
determine whether a given vnd property is writeable or not. The property
to check is specified in prop and should be from the list described in
libvnd(3VND). The argument wp is a pointer to a boolean_t which will be
updated upon the successful completion of the function. The argument wp
must be a valid pointer. If a property is writeable than the value
pointed to by wp is set to B_TRUE. If the property is read-only, then the
value is set to B_FALSE.

RETURN VALUES

On success, vnd_prop_writeable returns zero and the value pointed to by
wp is updated with whether the property is writeable. If the property
prop does not exist, then vnd_prop_writeable will return -1.

EXAMPLES

Example 1 Check whether the property VND_PROP_TXBUF is writable

The following sample C program checks whether the vnd property
VND_PROP_TXBUF is writeable or not.

#include <libvnd.h>
#include <stdio.h>
#include <stdlib.h>

int
main(void)
{
boolean_t canwrite;

if (vnd_prop_writeable(VND_PROP_TXBUF, &prop) != 0)
abort();

if (canwrite == B_TRUE)
(void) printf("VND_PROP_TXBUF is writeable0);
else
(void) printf("VND_PROP_TXBUF is read only0);

return (0);
}