PreviousNext

uuid_is_nil(3rpc)

Determines if a UUID is nil

Used by client, server, or management applications.

Synopsis

#include <dce/uuid.h>

boolean32 uuid_is_nil(

uuid_t *uuid,

unsigned32 *status);

Parameters

Input

uuid
Specifies a UUID to test as a nil UUID. Supply NULL to specify a nil UUID for this parameter.

Output

status
Returns the status code from this routine. This status code indicates whether the routine completed successfully or, if not, why not.

Description
The uuid_is_nil( ) routine determines whether the specified UUID is a nil UUID. This routine yields the same result as if an application did the following:

· Called the uuid_create_nil( ) routine.

· Called the uuid_equal( ) routine to compare the returned nil UUID to the UUID specified in the uuid parameter.

Return Values
The possible return values and their meanings are as follows:

TRUE The uuid parameter is a nil UUID. Parameter status contains the status code uuid_s_ok.
FALSE The uuid parameter is not a nil UUID.
Errors

The following describes a partial list of errors that might be returned. Refer to the OSF DCE Problem Determination Guide for complete descriptions of all error messages.

uuid_s_ok
Success.

uuid_s_bad_version
Bad UUID version.

Related Information
Functions: uuid_compare(3rpc)

uuid_create_nil(3rpc)

uuid_equal(3rpc)