NAME

rpc_mgmt_ep_elt_inq_begin- creates an inquiry context for viewing the elements in an endpoint map

SYNOPSIS

#include <dce/rpc.h>

void rpc_mgmt_ep_elt_inq_begin(
	rpc_binding_handle_t ep_binding,
	unsigned32 inquiry_type,
	rpc_if_id_t *if_id,
	unsigned32 vers_option,
	uuid_t *object_uuid,
	rpc_ep_inq_handle_t *inquiry_context,
	unsigned32 *status);

PARAMETERS

Input

ep_binding

Specifies the host whose endpoint map elements will be viewed.

To view elements from the local host, the application specifies NULL.

To view endpoint map elements from another host, the application specifies a server binding handle for that host. The object UUID associated with this argument must be a nil UUID. When a non-nil UUID is specified, the routine fails with the status code ept_s_cant_perform_op.

inquiry_type

An integer value that indicates the type of inquiry to perform on the endpoint map. The following list presents the valid inquiry types:

Value

Description

rpc_c_ep_all_elts

Returns every element from the endpoint map.

The if_id, vers_option and object_uuid arguments are ignored.

rpc_c_ep_match_by_if

Searches the endpoint map for those elements that contain the interface identifier specified by the if_id and vers_option values.

The object_uuid argument is ignored.

rpc_c_ep_match_by_obj

Searches the endpoint map for those elements that contain the object UUID specified by the object_uuid argument.

The if_id and vers_option arguments are ignored.

rpc_c_ep_match_by_both

Searches the endpoint map for those elements that contain the interface identifier and object UUID specified by the if_id, vers_option and object_uuid arguments.

if_id

Specifies the interface identifier of the endpoint map elements to be returned by the rpc_mgmt_ep_elt_inq_next routine.

This argument is meaningful only when inquiry_type is one of rpc_c_ep_match_by_if or rpc_c_ep_match_by_both. Otherwise, the argument is ignored.

vers_option

Specifies how the rpc_mgmt_ep_elt_inq_next() routine uses the if_id argument.

This argument is meaningful only when inquiry_type is one of rpc_c_ep_match_by_if or rpc_c_ep_match_by_both. Otherwise, this argument is ignored.

The following list presents the valid values for this argument.

Value

Description

rpc_c_vers_all

Returns endpoint map elements that offer the specified interface UUID, regardless of the version numbers.

rpc_c_vers_compatible

Returns endpoint map elements that offer the same major version of the specified interface UUID and a minor version greater than or equal to the minor version of the specified interface UUID.

rpc_c_vers_exact

Returns endpoint map elements that offer the specified version of the specified interface UUID.

rpc_c_vers_major_only

Returns endpoint map elements that offer the same major version of the specified interface UUID (ignores the minor version).

rpc_c_vers_upto

Returns endpoint map elements that offer a version of the specified interface UUID less than or equal to the specified major and minor version.

object_uuid

Specifies the object UUID that the rpc_mgmt_ep_elt_inq_next() routine looks for in endpoint map elements.

This argument is meaningful only when inquiry_type is one of rpc_c_ep_match_by_obj or rpc_c_ep_match_by_both. Otherwise, this argument is ignored.

Output

inquiry_context

Returns an inquiry context for use with the rpc_mgmt_ep_elt_inq_next() and rpc_mgmt_ep_elt_inq_done() routines.

status

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

Possible status codes and their meanings include:

rpc_s_ok

Success.

DESCRIPTION

The rpc_mgmt_ep_elt_inq_begin() routine creates an inquiry context for viewing server address information stored in the endpoint map.

Using the inquiry_type and vers_option arguments, an application specifies which of the following endpoint map elements are to be returned from calls to the rpc_mgmt_ep_elt_inq_next() routine:

• all elements

• those elements with the specified interface identifier

• those elements with the specified object UUID

• those elements with both the specified interface identifier and object UUID.

Before calling the rpc_mgmt_ep_elt_inq_next() routine, the application must first call this routine to create an inquiry context.

After viewing the endpoint map elements, the application calls the rpc_mgmt_ep_elt_inq_done() routine to delete the inquiry context.

RETURN VALUE

None.

SEE ALSO

rpc_ep_register()
rpc_ep_register_no_replace()
rpc_ep_unregister()
rpc_mgmt_ep_elt_inq_done()
rpc_mgmt_ep_elt_inq_next()
rpc_mgmt_ep_unregister().

Please note that the html version of this specification may contain formatting aberrations. The definitive version is available as an electronic publication on CD-ROM from The Open Group.