NAME

CORBA::Object::get_client_policy - (operation) return the effective overriding policy of the given type


SYNOPSIS

IDL

  module CORBA
    {
    typedef unsigned long PolicyType ;
    interface Object
      {
      Policy get_client_policy ( in PolicyType type ) ;
      } ;
    } ;

C

  #include <orb.h>
  typedef CORBA_unsigned_long          CORBA_PolicyType ;
  CORBA_Policy CORBA_Object_get_client_policy
      ( CORBA_Object o,
      CORBA_PolicyType type,
      CORBA_Environment * ev ) ;

C++

  #include <orb.h>
  namespace CORBA
    {
    typedef CORBA::Ulong PolicyType ;
    class Object
      {
        public:
          Policy_ptr _get_client_policy ( PolicyType type ) ;
      } ;
    } ;

Java

  package org.omg.CORBA ;
  public interface Object
    {
      Policy _get_client_policy ( int type ) ;
    }

Perl

(TBS)

Lisp

(TBS)


DESCRIPTION

The CORBA::Object::get_client_policy operation returns the effective overriding policy of the specified type.

This operation first searches for a policy of the given type at the Object scope, then at the Current (thread) scope, then at the ORB scope. The first such policy found (that is, the one in the most enclosed scope) is returned.

If no policy of the given type is found, then if a default policy has been established by the system, then the default policy is returned. Otherwise, the nil object is returned.


PARAMETERS

type (in, PolicyType, unsigned long)

The type of overriding policy to be found.

o

(C mapping only) the target object

ev

(C mapping only) a pointer to the CORBA_Environment


RETURN VALUE

The effective overriding policy of type type; or, if none, the nil object.


EXCEPTIONS

(standard system exceptions)


NOTES

  1. (C++ mapping only) The IDL header is named orb.idl. The C++ mapping specification does not mention a specific header name. One might presume the header name should be orb.h. However, some ORB vendors are more imaginative, and use other, different header file names.

  2. (C++ mapping only) The C++ mapping of names may vary, depending on the implementation's support for nested classes and namespaces. The rules are:

        if C++ namespace is supported,
            then map IDL module to C++ namespace
        else if C++ nested classes are supported,
            then map IDL module to a C++ class
        else
            use the C mapping for names

    The C++ synopsis, above, assumes namespace support. For other situations, adjust accordingly.


SEE ALSO

CORBA::Object(3corba)


COPYRIGHT

Copyright 2012 Michael Marking. This document is distributed as part of corbadoc, a documentation-only package with the goal of describing the main CORBA-related definitions from the OMG specifications. This is version corbadoc-0.1.3-prototype, released 2011.12.23. corbadoc is an incomplete work in progress; this is a snapshot release. New releases will be posted at http://www.tatanka.com/software/corbadoc/.

The corbadoc documents, including this one, are licensed under the GNU Free Documentation License, v.1.3.