rpc_ns_profile_elt_inq_begin- creates an inquiry context for viewing the elements in a profile
#include <dce/rpc.h>
void rpc_ns_profile_elt_inq_begin(
unsigned32 profile_name_syntax,
unsigned_char_t *profile_name,
unsigned32 inquiry_type,
rpc_if_id_t *if_id,
unsigned32 vers_option,
unsigned32 member_name_syntax,
unsigned_char_t *member_name,
rpc_ns_handle_t *inquiry_context,
unsigned32 *status);
Input
- profile_name_syntax
- An integer value that specifies the syntax of argument profile_name. (See
Name Syntax Constants for the possible values of this argument.)The value rpc_c_ns_syntax_default specifies the syntax specified by the RPC_DEFAULT_ENTRY_SYNTAX environment variable.
- profile_name
- Specifies the RPC profile to view. The profile name syntax is identified by the argument profile_name_syntax.
- inquiry_type
- An integer value that specifies the type of inquiry to perform on the profile. The following list describes the valid values for this argument:
- Value
- Description
- rpc_c_profile_default_elt
Searches the profile for the default profile element, if any.The if_id, vers_option, and member_name arguments are ignored.
- rpc_c_profile_all_elts
Returns every element from the profile.The if_id, vers_option, and member_name arguments are ignored.
- rpc_c_profile_match_by_if
Searches the profile for those elements that contain the interface identifier specified by the if_id and vers_option values.The member_name argument is ignored.
- rpc_c_profile_match_by_mbr
Searches the profile for those elements that contain the member name specified by the member_name argument.The if_id and vers_option arguments are ignored.
- rpc_c_profile_match_by_both
Searches the profile for those elements that contain the interface identifier and member name specified by the if_id, vers_option and member_name arguments.
- if_id
- Specifies the interface identifier of the profile elements to be returned by the rpc_ns_profile_elt_inq_next() routine.
This argument is meaningful only when specifying a value of rpc_c_profile_match_by_if or rpc_c_profile_match_by_both for the inquiry_type argument. Otherwise, this argument is ignored and the application can specify the value NULL.
- vers_option
- Specifies how the rpc_ns_profile_elt_inq_next() routine uses the if_id argument.
This argument is used only when specifying a value of rpc_c_profile_match_by_if or rpc_c_profile_match_by_both for the inquiry_type argument. Otherwise, this argument is ignored.
The following list describes the valid values for this argument:
- Value
- Description
- rpc_c_vers_all
- Returns profile elements that offer the specified interface UUID, regardless of the version numbers.
- rpc_c_vers_compatible
Returns profile 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 profile elements that offer the specified version of the specified interface UUID.
- rpc_c_vers_major_only
Returns profile elements that offer the same major version of the specified interface UUID (ignores the minor version).
- rpc_c_vers_upto
- Returns profile elements that offer a version of the specified interface UUID less than or equal to the specified major and minor version.
- member_name_syntax
- An integer value that specifies the syntax of argument member_name in this routine and the syntax of argument member_name in the rpc_ns_profile_elt_inq_next() routine. (See
Name Syntax Constants for the possible values of this argument.)The value rpc_c_ns_syntax_default specifies the syntax specified by the RPC_DEFAULT_ENTRY_SYNTAX environment variable.
- member_name
- Specifies the member name that the rpc_ns_profile_elt_inq_next() routine looks for in profile elements. The member name syntax is identified by the argument member_name_syntax.
This argument is meaningful only when specifying a value of rpc_c_profile_match_by_mbr or rpc_c_profile_match_by_both for the inquiry_type argument. Otherwise, this argument is ignored.
Output
- inquiry_context
- Returns a name service handle for use with the rpc_ns_profile_elt_inq_next() and rpc_ns_profile_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.
- rpc_s_unsupported_name_syntax
Unsupported name syntax.
The rpc_ns_profile_elt_inq_begin() routine creates an inquiry context for viewing the elements in a profile.Using the inquiry_type and vers_option arguments, an application specifies which of the following profile elements will be returned from calls to the rpc_ns_profile_elt_inq_next() routine:
- the default element
- all elements
- those elements with the specified interface identifier
- those elements with the specified member name
- those elements with both the specified interface identifier and member name.
The application calls this routine to create an inquiry context before calling the rpc_ns_profile_elt_inq_next() routine.
When finished viewing profile elements, the application calls the rpc_ns_profile_elt_inq_done() routine to delete the inquiry context.
Permissions Required
None.
None.
rpc_if_inq_id()
rpc_ns_mgmt_handle_set_exp_age()
rpc_ns_profile_elt_inq_done()
rpc_ns_profile_elt_inq_next().
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.
| Contents | Next section | Index |