Index for Section 3

Alphabetical listing for G

Bottom of page

getdiskbyname(3)
NAME
  getdiskbyname - Get the disk description using a disk name

SYNOPSIS
  #include <sys/disklabel.h>
  #include <sys/types.h>

  struct disklabel *getdiskbyname(
	  char *name );

  int getdiskbyname_r(
	  char *name,
	  struct disklabel *disk,
	  char *book,
	  int boot_len );

LIBRARY
  Standard C Library (libc)

PARAMETERS
  name
      Specifies a common name for the disk drive whose geometry and partition
      characteristics are sought.

  disk
      Points to the structure that will contain the returned disk
      description.

  boot
      Points to the buffer that will contain the optional names of the
      primary and secondary bootstraps.

  boot_len
      Specifies the length of boot. This should be BUFSIZ.

DESCRIPTION
  Operations supported by the getdiskbyname function are also supported by
  the createlabel function. See createlabel(3). The getdiskbyname and
  getdiskbyname_r functions are supported only for backward compatibility
  with Digital UNIX Version 4.0 and earlier versions. These functions will be
  retired in a future release of Tru64 UNIX.

  The getdiskbyname() function uses a disk (disk drive) name to return a
  pointer to a structure that describes the geometry and standard partition
  characteristics of the named disk drive. Information obtained from the
  /etc/disktab database file is written to the type disklabel structure space
  referenced by the returned pointer.

  The getdiskbyname_r() function is the reentrant version of getdiskbyname().
  Upon successful completion, getdiskbyname_r() returns a value of 0 (zero);
  the returned structure is pointed at by disk.	 Upon error, it returns a
  value of -1, and may set errno to [EINVAL].

RETURN VALUES
  Upon successful completion, the getdiskbyname() function, returns a pointer
  to a type disklabel structure.

ERRORS
  [EINVAL]
      Either disk or boot is NULL, or boot_len is not equal to BUFSIZ.

SEE ALSO
  Functions: createlabel(3)

  Files: disklabel(4), disktab(4)

  Commands: disklabel(8)

Index for Section 3

Alphabetical listing for G

Top of page